X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FProtocols%2FINet%2FINet6Address.hh;h=953bc491fa04d7936441a16412cfd5a71c6b9416;hb=d001b1fe2a8fb121145d2a111d737219abae20d7;hp=1beecf9484544bc376ae21bcbed86dd94b6fca07;hpb=f85e1ac1d9bddeafd54b2171b8c7dd611842f7d3;p=senf.git diff --git a/Socket/Protocols/INet/INet6Address.hh b/Socket/Protocols/INet/INet6Address.hh index 1beecf9..953bc49 100644 --- a/Socket/Protocols/INet/INet6Address.hh +++ b/Socket/Protocols/INet/INet6Address.hh @@ -23,8 +23,8 @@ /** \file \brief INet6Address public header */ -#ifndef HH_INet6Address_ -#define HH_INet6Address_ 1 +#ifndef HH_SENF_Socket_Protocols_INet_INet6Address_ +#define HH_SENF_Socket_Protocols_INet_INet6Address_ 1 // Custom includes #include @@ -46,7 +46,7 @@ namespace senf { /** \brief INet6 network address - This implementation of an INet6 address is based strictly on + This implementation of an INet6 address is based strictly on RFC 4291: Internet Protocol Version 6 (INet6) Addressing Architecture. This class provides accessors to all the information fields defined in this document. @@ -66,7 +66,7 @@ namespace senf { 2002::/16 prefix \li RFC 3849: INet6 Address Prefix Reserved for Documentation. Defines the 2001:db8::/32 prefix - + Here an overview of well-known prefixes: \htmlonly @@ -141,8 +141,8 @@ namespace senf { /** \brief Possible scope values List of all possible scope values. This list includes all scope values defined for - multicast addresses in RFC 4291. - The values \ref LinkScope, \ref SiteScope and \ref GlobalScope are also used with + multicast addresses in RFC 4291. + The values \ref LinkScope, \ref SiteScope and \ref GlobalScope are also used with unicast addresses. */ enum ScopeId { @@ -155,7 +155,7 @@ namespace senf { , ReservedScope = 0 /**< Reserved scope value */ , UnassignedScope = 6 /**< Unassigned scope, may be defined locally */ - }; + }; /////////////////////////////////////////////////////////////////////////// ///\name Structors and default members @@ -166,7 +166,7 @@ namespace senf { boost::uint16_t a3=0u, boost::uint16_t a4=0u, boost::uint16_t a5=0u, boost::uint16_t a6=0u, boost::uint16_t a7=0u); ///< Construct an address constant - + static INet6Address from_in6addr(in6_addr const & in6addr); ///< Construct from std C struct static INet6Address from_string(std::string const & s, Resolve_t resolve = ResolveINet6); @@ -179,30 +179,32 @@ namespace senf { protocol like DNS or NIS \throws AddressSyntaxException if the address cannot be converted for some reason - \param[in] s Address literal or hostname + \param[in] s Address literal or hostname \param[in] resolve If this is set to \c ResolveINet4, the call will additionally try to interpret \a s as an INet4 address if no valid INet6 address is found. The address will be returned as mapped INet6 address. */ - template + template static INet6Address from_data(InputIterator i); ///< Construct address from 16 bytes of raw data /**< from_data will build an address from 16 bytes of raw data as accessed by the iterator. The data must be in network byte order. */ - static INet6Address from_inet4address(INet4Address addr); + static INet6Address from_inet4address(INet4Address const & addr); ///< Construct an INet6-mapped INet4 address /**< This will construct an address of the form ::FFFF::w.x.y.z where w.x.y.z is the INet4Address value. This kind of address is called - an INet6-mapped INet4 address (see + an INet6-mapped INet4 address (see RFC 4291). - \par + \par INet4 compatible INet6 addresses are not directly supported, they are deprecated in the RFC. */ + in6_addr toin6_addr() const; ///< get the linux in6_addr struct (convinience only) + ///@} /////////////////////////////////////////////////////////////////////////// ///\name Accessors @@ -216,6 +218,12 @@ namespace senf { bool unicast() const; ///< \c true, if address is unicast bool multicast() const; ///< \c true, if address is multicast + /**< To support a linux specific extension, INet4 multicast + addressed mapped to INet6 are also interpreted as + multicast addresses. This is NOT part of the standard, + however the standard officially only allows unicast v4 + addresses to be mapped to v6 so this does not collide + with any standard conforming use. */ ScopeId scope() const; ///< Get address's scope /**< The scope of an address is one of the \ref ScopeId @@ -224,7 +232,7 @@ namespace senf { site or global scope (where site scope is deprecated), multicast address can have a number of scope values of which local, site and global are a few. See the \ref - ScopeId enumerators. */ + ScopeId enumerators. */ bool globalScope() const; ///< \c true, if address is global unicast or multicast bool linkScope() const; ///< \c true, if address is link-local unicast or multicast @@ -234,23 +242,23 @@ namespace senf { is given by the last 32 bits of the INet6 address. \par The value returned is only a valid INet4 address if either inet4Compatible() or inet4Mapped() return \c - true. */ + true. */ bool inet4Compatible() const; ///< \c true, if address is INet4 compatible /**< INet4 compatible INet6 addresses are deprecated. */ bool inet4Mapped() const; ///< \c true, if address is INet4 mapped bool globalMulticastAddr() const; ///< \c true, if T bit is \e not set /**< Any multicast address with a cleared T bit must be - globally assigned. See + globally assigned. See RFC 4291. */ bool prefixMulticastAddr() const; ///< \c true, if P bit is set /**< In RFC 4291, the P bit is specified as defining a - unicast prefix based multicast address. See - RFC 3306. */ + unicast prefix based multicast address. See + RFC 3306. */ bool embeddedRpAddr() const; ///< \c true, if R bit is set /**< In RFC 4291, - the R bit is specified as defining a multicast address + the R bit is specified as defining a multicast address with embedded rendezvous point. See RFC 3956. */ @@ -259,7 +267,7 @@ namespace senf { ///@} ///\name Mutators ///@{ - + void network(boost::uint64_t net); ///< Set network part of address void id(boost::uint64_t id); ///< Set interface id part of address @@ -271,9 +279,15 @@ namespace senf { \related INet6Address */ std::ostream & operator<<(std::ostream & os, INet6Address const & addr); + /** \brief Try to initialize INet6Address instance from a string representation + sets std::ios::failbit on the stream if an error occurred + \see INet6Address from_string() + \related INet6Address + */ + std::istream & operator>>(std::istream & is, INet6Address & addr); /** \brief Check INet6Address against a fixed network prefix - + This helper allows to easily and efficiently check an INet6Address against an arbitrary but constant network prefix. It takes from 1 to 8 arguments for the network address and an additional last argument providing the prefix length. So @@ -283,13 +297,13 @@ namespace senf { ... , prefix_len > represents the network - + \par "" addr_1 : addr_2 : ... ::/ prefix_len . The class exposes a single static member match( addr ) which matches the INet6Address \a addr against the prefix: - + \code if (senf::CheckINet6Network<0x2000u,0xDB8u,32u>::match(addr)) { // 'addr' is within in the 2001:db8::/32 documentation-only network @@ -302,15 +316,17 @@ namespace senf { template struct CheckINet6Network +#ifndef DOXYGEN : public detail::CheckINet6Network_impl +#endif {}; /** \brief INet6 network prefix - This class represents an INet6 network prefix in CIDR notation. + This class represents an INet6 network prefix in CIDR notation. */ class INet6Network - : public boost::equality_comparable, + : public boost::equality_comparable, public comparable_safe_bool { public: @@ -319,9 +335,9 @@ namespace senf { ///@{ INet6Network(); ///< Construct empty (::/0) network - INet6Network(INet6Address address, unsigned prefix_len); + INet6Network(INet6Address const & address, unsigned prefix_len); ///< Construct network from given address and prefix length - explicit INet6Network(std::string s); ///< Construct network from CIDR notation + explicit INet6Network(std::string const & s); ///< Construct network from CIDR notation ///@} /////////////////////////////////////////////////////////////////////////// @@ -332,9 +348,9 @@ namespace senf { bool boolean_test() const; ///< \c true, if INet6Network is non-empty bool operator==(INet6Network const & other) const; ///< Compare two networks for equality - - bool match(INet6Address addr) const; ///< \c true, if the network includes \a addr - bool match(INet6Network net) const; ///< \c true, if the network includes \a net + + bool match(INet6Address const & addr) const; ///< \c true, if the network includes \a addr + bool match(INet6Network const & net) const; ///< \c true, if the network includes \a net /**< The is true, if \a net is sub-network (or the same as) \c this. */ INet6Address host(boost::uint64_t id); ///< Return the host with the given id @@ -350,7 +366,7 @@ namespace senf { \code INet6Network("2001:db8::/32").subnet(0x12u,40u) == INet6Network("2001:db8:1200::/40") INet6Network("2001:db8:1200::/40").subnet(0x2345,64u) == INet6Network("2001:db8:1200:2345::/64") - \endcode + \endcode \param[in] net network number \param[in] prefix_len length of subnet prefix */ @@ -373,7 +389,7 @@ namespace senf { #include "INet6Address.cti" #endif - + // Local Variables: // mode: c++ // fill-column: 100