added hints for RawInetSockets/Protocols (port = protocol)
atx23 [Wed, 18 Nov 2009 12:39:55 +0000 (12:39 +0000)]
git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1533 270642c3-0616-0410-b53a-bc976706d245

senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh
senf/Socket/Protocols/INet/RawINetSocketHandle.hh

index ddcec24..25d783e 100644 (file)
@@ -69,6 +69,10 @@ namespace senf {
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
 
+        \attention
+            If socket handle with ConnectedRawV4SocketProtocol is connected via INet4SocketAddress, the port number
+            is interpreted as protocol number for IPv4 layer. Please refer manpage: "man 7 raw".
+
         \see ConnectedRawV6SocketProtocol
         \see RawV4SocketProtocol
         \see RawV6SocketProtocol
@@ -137,6 +141,10 @@ namespace senf {
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
 
+               \attention
+            If socket handle with ConnectedRawV6SocketProtocol is connected via INet6SocketAddress, the port number
+            is interpreted as protocol number for IPv6 layer. Please refer manpage: "man 7 ipv6".
+
         \see ConnectedRawV4SocketProtocol
         \see RawV4SocketProtocol
         \see RawV6SocketProtocol
index ca1c380..e860dca 100644 (file)
@@ -71,6 +71,10 @@ namespace senf {
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
 
+        \attention
+            If socket handle with RawV4SocketProtocol is connected via INet4SocketAddress, the port number
+            is interpreted as protocol number for IP layer. Please refer manpage: "man 7 raw".
+
         \see RawV6SocketProtocol
      */
     class RawV4SocketProtocol
@@ -138,6 +142,10 @@ namespace senf {
         This class is utilized as the protocol class of the ProtocolClientSocketHandle
         via the Socket Handle typedefs above.
 
+        \attention
+            If socket handle with ConnectedRawV6SocketProtocol is connected via INet6SocketAddress, the port number
+            is interpreted as protocol number for IPv4 layer. Please refer manpage: "man 7 ipv6".
+
         \see RawV4SocketProtocol
      */
     class RawV6SocketProtocol