added hints for RawInetSockets/Protocols (port = protocol)

[senf.git] / senf / Socket / Protocols / INet / RawINetSocketHandle.hh

diff --git a/senf/Socket/Protocols/INet/RawINetSocketHandle.hh b/senf/Socket/Protocols/INet/RawINetSocketHandle.hh
index ca1c380..e860dca 100644 (file)
--- a/senf/Socket/Protocols/INet/RawINetSocketHandle.hh
+++ b/senf/Socket/Protocols/INet/RawINetSocketHandle.hh
@@ -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