From: g0dil Date: Fri, 23 Nov 2007 12:49:43 +0000 (+0000) Subject: Documentation updates X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=04710eb4ddde16d610a598e69798cfb15d4db880;p=senf.git Documentation updates Rename IpV[46]* -> IPv[46]* git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@531 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Socket/Protocols/INet/INet4Address.cc b/Socket/Protocols/INet/INet4Address.cc index 2bc9198..846d857 100644 --- a/Socket/Protocols/INet/INet4Address.cc +++ b/Socket/Protocols/INet/INet4Address.cc @@ -59,7 +59,7 @@ prefix_ senf::INet4Address senf::INet4Address::from_string(std::string const & s int herr (0); // If available, we use the reentrant GNU variant. This has the additional advantage, that we - // can explicitly ask for IpV4 addresses + // can explicitly ask for IPv4 addresses # ifdef __GLIBC__ diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh index b163aaa..b62eb7d 100644 --- a/Socket/Protocols/INet/INet4Address.hh +++ b/Socket/Protocols/INet/INet4Address.hh @@ -39,7 +39,7 @@ namespace senf { - /** \brief IpV4 Internet address + /** \brief IPv4 Internet address INet4Address represents a simple IP address. It is modelled as a fixed-size container/sequence of 4 bytes. @@ -187,9 +187,9 @@ namespace senf { static bool match(INet4Address const & addr); }; - /** \brief IpV4 network prefix + /** \brief IPv4 network prefix - This class represents an IpV4 network prefix in CIDR notation. + This class represents an IPv4 network prefix in CIDR notation. */ class INet4Network : public boost::equality_comparable, diff --git a/Socket/Protocols/INet/INet6Address.cc b/Socket/Protocols/INet/INet6Address.cc index 93f5963..ed3c5e2 100644 --- a/Socket/Protocols/INet/INet6Address.cc +++ b/Socket/Protocols/INet/INet6Address.cc @@ -54,7 +54,7 @@ prefix_ senf::INet6Address senf::INet6Address::from_string(std::string const & s int herr (0); // If available, we use the reentrant GNU variant. This has the additional advantage, that we - // can explicitly ask for IpV4 addresses + // can explicitly ask for IPv4 addresses # ifdef __GLIBC__ diff --git a/Socket/Protocols/INet/INet6Address.hh b/Socket/Protocols/INet/INet6Address.hh index 877752b..70a38bd 100644 --- a/Socket/Protocols/INet/INet6Address.hh +++ b/Socket/Protocols/INet/INet6Address.hh @@ -41,14 +41,14 @@ namespace senf { - /** \brief IpV6 network address + /** \brief IPv6 network address - This implementation of an IpV6 address is based strictly on + This implementation of an IPv6 address is based strictly on RFC 4291: Internet Protocol Version 6 (IPv6) Addressing Architecture. This class provides accessors to all the information fields defined in this document. - The IpV6 addressing architecture however has several other components defined in other + The IPv6 addressing architecture however has several other components defined in other RFC's. These RFC's should be implemented in additional modules: \li RFC 4193: @@ -68,8 +68,8 @@ namespace senf { - - + + @@ -153,8 +153,8 @@ namespace senf { \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 IpV4 address if no valid IpV6 address is - found. The address will be returned as mapped IpV6 + an IPv4 address if no valid IPv6 address is + found. The address will be returned as mapped IPv6 address. */ template @@ -165,14 +165,14 @@ namespace senf { network byte order. */ static INet6Address from_inet4address(INet4Address addr); - ///< Construct an IpV6-mapped IpV4 address + ///< Construct an IPv6-mapped IPv4 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 IpV6-mapped IpV4 address (see + an IPv6-mapped IPv4 address (see RFC 4291). \par - IpV4 compatible IpV6 addresses are not directly + IPv4 compatible IPv6 addresses are not directly supported, they are deprecated in the RFC. */ ///@} /////////////////////////////////////////////////////////////////////////// @@ -199,16 +199,16 @@ namespace senf { 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 - INet4Address inet4address() const; ///< Return embedded IpV4 address - /**< Returns the IpV4 address embedded within an IpV4 - compatible or IpV4 mapped unicast address. This address - is given by the last 32 bits of the IpV6 address. \par - The value returned is only a valid IpV4 address if + INet4Address inet4address() const; ///< Return embedded IPv4 address + /**< Returns the IPv4 address embedded within an IPv4 + compatible or IPv4 mapped unicast address. This address + is given by the last 32 bits of the IPv6 address. \par + The value returned is only a valid IPv4 address if either ipv4Compatible() or ipv4Mapped() return \c true. */ - bool ipv4Compatible() const; ///< \c true, if address is IpV4 compatible - /**< IpV4 compatible IpV6 addresses are deprecated. */ - bool ipv4Mapped() const; ///< \c true, if address is IpV4 mapped + bool ipv4Compatible() const; ///< \c true, if address is IPv4 compatible + /**< IPv4 compatible IPv6 addresses are deprecated. */ + bool ipv4Mapped() const; ///< \c true, if address is IPv4 mapped bool globalMulticastAddr() const; ///< \c true, if T bit is \e not set /**< Any multicast address with a cleared T bit must be @@ -288,9 +288,9 @@ namespace senf { : public detail::CheckINet6Network_impl {}; - /** \brief IpV6 network prefix + /** \brief IPv6 network prefix - This class represents an IpV6 network prefix in CIDR notation. + This class represents an IPv6 network prefix in CIDR notation. */ class INet6Network : public boost::equality_comparable, diff --git a/Socket/Protocols/INet/INetAddressing.hh b/Socket/Protocols/INet/INetAddressing.hh index f2972e0..9fd1281 100644 --- a/Socket/Protocols/INet/INetAddressing.hh +++ b/Socket/Protocols/INet/INetAddressing.hh @@ -101,7 +101,7 @@ namespace senf { struct SyntaxException : public std::exception { virtual char const * what() const throw() - { return "Invalid IpV4 socket address syntax"; } }; + { return "Invalid IPv4 socket address syntax"; } }; private: struct ::sockaddr_in addr_; @@ -164,7 +164,7 @@ namespace senf { address cannot be resolved. \param[in] addr Address to parse \param[in] resolve If this is - INet6Address::ResolveINet4, support IpV4 + INet6Address::ResolveINet4, support IPv4 addresses. See INet6Address. */ INet6SocketAddress(INet6Address const & addr, unsigned port); ///< Initialize from address and port @@ -200,7 +200,7 @@ namespace senf { struct SyntaxException : public std::exception { virtual char const * what() const throw() - { return "Invalid IpV6 socket address syntax"; } }; + { return "Invalid IPv6 socket address syntax"; } }; protected:
Prefix Description Definition Note
::/96 IpV4 compatible IpV6 address RFC4291 deprecated
::ffff:0:0/96 IpV6 mapped IpV4 address RFC4291
::/96 IPv4 compatible IPv6 address RFC4291 deprecated
::ffff:0:0/96 IPv6 mapped IPv4 address RFC4291
2000::/3 Global unicast addresses RFC3587 only noted, not defined
2001:db8::/32 Documentation-only prefix RFC3849
2002::/16 6to4 addressing RFC3056