From: tho Date: Wed, 13 Oct 2010 13:23:41 +0000 (+0000) Subject: Socket: some minor documentation (typo) fixes X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=874b9d37b59223d9b0dce3bddafa130045419750 Socket: some minor documentation (typo) fixes Packets: minor unit test added git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1734 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/senf/Packets/DefaultBundle/EthernetPacket.test.cc b/senf/Packets/DefaultBundle/EthernetPacket.test.cc index df66a5d..79414ba 100644 --- a/senf/Packets/DefaultBundle/EthernetPacket.test.cc +++ b/senf/Packets/DefaultBundle/EthernetPacket.test.cc @@ -74,6 +74,9 @@ SENF_AUTO_UNIT_TEST(ethernetPacket_parse_chain) BOOST_CHECK_EQUAL( v->type(), 0xabcd ); BOOST_CHECK( v.next().is() ); BOOST_CHECK_EQUAL( *v.next().data().begin(), 0xf0 ); + + std::ostringstream oss (std::ostringstream::out); + SENF_CHECK_NO_THROW( p.dump( oss)); } SENF_AUTO_UNIT_TEST(ethernetPacket_create) diff --git a/senf/Socket/FramingPolicy.hh b/senf/Socket/FramingPolicy.hh index 5359c27..94f9acb 100644 --- a/senf/Socket/FramingPolicy.hh +++ b/senf/Socket/FramingPolicy.hh @@ -55,7 +55,7 @@ namespace senf { API. It however affects the semantics of the read and write operations. On a datagram socket, each read() or write() call we read or write a single datagram. Datagram boundaries are - kept intact accross the network. + kept intact across the network. */ struct DatagramFramingPolicy : public FramingPolicyBase {}; diff --git a/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh b/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh index e1fadbc..c81a15e 100644 --- a/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh +++ b/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh @@ -141,7 +141,7 @@ namespace senf { ConnectedRawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing which is connected to certain peer. This socket will put data written to it onto - the IPv6 layer: if you call writeto don't inlude the header! On the other hand `read` will + the IPv6 layer: if you call writeto don't include the header! On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header. Note: This behaviour is differs from the behaviour of IPv4 RAW sockets. diff --git a/senf/Socket/Protocols/INet/INet4Address.hh b/senf/Socket/Protocols/INet/INet4Address.hh index b214fc3..43f576e 100644 --- a/senf/Socket/Protocols/INet/INet4Address.hh +++ b/senf/Socket/Protocols/INet/INet4Address.hh @@ -119,6 +119,8 @@ namespace senf { protocol like DNS or NIS \throws AddressSyntaxException if the address cannot be converted for some reason + \throws UnknownHostnameException if the hostname cannot + be resolved \param[in] s Address literal or hostname */ template @@ -179,7 +181,7 @@ namespace senf { */ std::istream & operator>>(std::istream & os, INet4Address & addr); - /** \brief CHeck INet4Address against a fixed network prefix + /** \brief Check INet4Address against a fixed network prefix This helper allows to easily and efficiently check an INet4Address against an arbitrary but constant network prefix. The network prefix is represented by diff --git a/senf/Socket/Protocols/INet/INet6Address.hh b/senf/Socket/Protocols/INet/INet6Address.hh index cc26d96..66cc026 100644 --- a/senf/Socket/Protocols/INet/INet6Address.hh +++ b/senf/Socket/Protocols/INet/INet6Address.hh @@ -86,7 +86,7 @@ namespace senf { ff00::/8 Multicast RFC4291 ff00::/12 Globally allocated multicast RFC4291 ff10::/12 Locally allocated multicast RFC4291 - ff30::/12 Unicast prefic based multicast RFC3306 + ff30::/12 Unicast prefix based multicast RFC3306 ff70::/12 Multicast address with embedded RP RFC3956 \endhtmlonly @@ -176,12 +176,14 @@ namespace senf { ///< Convert string to address /**< This member will try to convert the given string into an IP address. from_string() supports all standard IP - literal representations as well es hostnames. + literal representations as well as hostnames. \attention This call may block if \a s represents a hostname which must be looked up via some network protocol like DNS or NIS \throws AddressSyntaxException if the address cannot be converted for some reason + \throws UnknownHostnameException if the hostname cannot + be resolved \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 @@ -216,7 +218,7 @@ namespace senf { /**< This will construct a link local address of the form fe80::xxxx:xxxx:xxxx:xxxx. */ - in6_addr toin6_addr() const; ///< get the linux in6_addr struct (convinience only) + in6_addr toin6_addr() const; ///< get the linux in6_addr struct (convenience only) ///@} /////////////////////////////////////////////////////////////////////////// diff --git a/senf/Socket/Protocols/INet/RawINetSocketHandle.hh b/senf/Socket/Protocols/INet/RawINetSocketHandle.hh index 10c23e0..78ec36c 100644 --- a/senf/Socket/Protocols/INet/RawINetSocketHandle.hh +++ b/senf/Socket/Protocols/INet/RawINetSocketHandle.hh @@ -64,7 +64,7 @@ namespace senf { INet4SocketAddress RawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing. - This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header! + This socket will put data written to it onto the IPv4 layer: if you call writeto don't include the header! On the other hand `read` will return the packet data including the IP header. This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future. @@ -135,7 +135,7 @@ namespace senf { INet6Address RawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing. - This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header! + This socket will put data written to it onto the IPv6 layer: if you call writeto don't include the header! On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header. Note: This behaviour is differs from the behaviour of IPv4 RAW sockets. diff --git a/senf/Socket/Protocols/INet/RawINetSocketProtocol.hh b/senf/Socket/Protocols/INet/RawINetSocketProtocol.hh index 467717b..b8af91c 100644 --- a/senf/Socket/Protocols/INet/RawINetSocketProtocol.hh +++ b/senf/Socket/Protocols/INet/RawINetSocketProtocol.hh @@ -31,7 +31,7 @@ namespace senf { /// \addtogroup protocol_facets_group /// @{ - /** \brief Protocol facat to support RAW operations upon IPv4/6 + /** \brief Protocol facet to support RAW operations upon IPv4/6 This protocol facet provides all those protocol functions, which are available on a PF_INET[6]/RAW socket. diff --git a/senf/Socket/Protocols/INet/TCPSocketProtocol.hh b/senf/Socket/Protocols/INet/TCPSocketProtocol.hh index 6ba240f..4c05a0d 100644 --- a/senf/Socket/Protocols/INet/TCPSocketProtocol.hh +++ b/senf/Socket/Protocols/INet/TCPSocketProtocol.hh @@ -38,7 +38,7 @@ namespace senf { /// \addtogroup protocol_facets_group /// @{ - /** \brief Protocol facat to support TCP operations + /** \brief Protocol facet to support TCP operations This protocol facet provides all those protocol functions, which are available on any TCP socket. @@ -52,7 +52,7 @@ namespace senf { /**< Enabling \c SO_NODELAY will disable the NAGLE algorithm (which aggregates multiple writes into a single network packet). Enabling nodelay() optimizes - the repsonse time at the expense of the bandwidth + the response time at the expense of the bandwidth efficiency. \param[in] value \c SO_NODELAY state */ diff --git a/senf/Socket/Protocols/INet/UDPSocketProtocol.hh b/senf/Socket/Protocols/INet/UDPSocketProtocol.hh index c043be4..6841c1d 100644 --- a/senf/Socket/Protocols/INet/UDPSocketProtocol.hh +++ b/senf/Socket/Protocols/INet/UDPSocketProtocol.hh @@ -38,7 +38,7 @@ namespace senf { /// \addtogroup protocol_facets_group /// @{ - /** \brief Protocol facat to support UDP operations + /** \brief Protocol facet to support UDP operations This protocol facet provides all those protocol functions, which are available on any UDP socket. diff --git a/senf/Socket/Protocols/Raw/EUI64.hh b/senf/Socket/Protocols/Raw/EUI64.hh index 3d8d5ab..1b0eacd 100644 --- a/senf/Socket/Protocols/Raw/EUI64.hh +++ b/senf/Socket/Protocols/Raw/EUI64.hh @@ -97,7 +97,7 @@ namespace senf { static EUI64 from_string(std::string const & s); ///< Construct EUI-64 from string representation /**< The string representation consists of 8 octets in - hexadecimal notation spearated by ':' or '-' + hexadecimal notation separated by ':' or '-' \throws senf::AddressSyntaxException */ template static EUI64 from_data(InputIterator i); @@ -117,7 +117,7 @@ namespace senf { */ bool group() const; ///< \c true if the \e group bit is set, \c false otherwise /**< The \e group bit is the least significant bit of the - first octed (bit 7 in standard RFC bit numbering). */ + first octet (bit 7 in standard RFC bit numbering). */ bool boolean_test() const; ///< \c true, if EUI64 is != 0, \c false otherwise boost::uint64_t uint64() const; ///< Return EUI64 as integer number }; diff --git a/senf/Socket/Protocols/Raw/LLAddressing.hh b/senf/Socket/Protocols/Raw/LLAddressing.hh index d4a9d32..0fa5017 100644 --- a/senf/Socket/Protocols/Raw/LLAddressing.hh +++ b/senf/Socket/Protocols/Raw/LLAddressing.hh @@ -111,7 +111,7 @@ namespace senf { std::string interface() const; ///< Return interface name unsigned protocol() const; ///< Return address protocol (ethertype) - unsigned arptype() const; ///< Return the hatype field (ARP hardware type) + unsigned arptype() const; ///< Return the arptype field (ARP hardware type) PktType pkttype() const; ///< Return type of packet // The mutating interface is purposely restricted to allow only diff --git a/senf/Socket/SocketPolicy.hh b/senf/Socket/SocketPolicy.hh index 8da09e9..0b24017 100644 --- a/senf/Socket/SocketPolicy.hh +++ b/senf/Socket/SocketPolicy.hh @@ -162,7 +162,7 @@ metafunction which simplifies building SocketPolicy instantiations. It takes any number (ok, up to a maximum of 6) of policy classes as an argument (in any order). It will sort these arguments into the SocketPolicy template arguments. If for some axis no class is specified, it's slot will - be filled with \c Unspecified \e Axis. Additionally, the first Argument may optionally be ab + be filled with \c Unspecified \e Axis. Additionally, the first Argument may optionally be an arbitrary SocketPolicy. It will provide default values for unspecified axis
\c template \c SocketPolicyIsBaseOf < \e base, \e derived >
This template diff --git a/tools/senf.dict b/tools/senf.dict index 97c7165..db608dc 100644 --- a/tools/senf.dict +++ b/tools/senf.dict @@ -190,6 +190,7 @@ ExampleVectorPolicy EXC ExceptionMixin ExtendedParser +failbit fbipList FBIPList fbips @@ -238,6 +239,7 @@ HardwareInterface HardwareWLANInterface headport Helvetica +hexadecimal hh hideinitializer Hmm @@ -408,6 +410,8 @@ nUsing NyInputGroup ob ObjectDirectory +octet +octets offene ok onChange @@ -594,6 +598,7 @@ SiteScope SizeParser skipline SNR +sockaddr SocketAddress SocketHandle SocketProtocol @@ -624,6 +629,7 @@ STL strerror struct structors +subnet subsubsection svn svnbook