added hints for RawInetSockets/Protocols (port = protocol)

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

diff --git a/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh b/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh
index 0f63559..25d783e 100644 (file)
--- a/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh
+++ b/senf/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh
@@ -26,12 +26,12 @@
 // Custom includes
 #include "INetSocketProtocol.hh"
 #include "RawINetSocketProtocol.hh"
-#include "../../../Socket/Protocols/BSDSocketProtocol.hh"
-#include "../../../Socket/Protocols/DatagramSocketProtocol.hh"
-#include "../../../Socket/FramingPolicy.hh"
-#include "../../../Socket/CommunicationPolicy.hh"
-#include "../../../Socket/ReadWritePolicy.hh"
-#include "../../../Socket/ProtocolClientSocketHandle.hh"
+#include <senf/Socket/Protocols/BSDSocketProtocol.hh>
+#include <senf/Socket/Protocols/DatagramSocketProtocol.hh>
+#include <senf/Socket/FramingPolicy.hh>
+#include <senf/Socket/CommunicationPolicy.hh>
+#include <senf/Socket/ReadWritePolicy.hh>
+#include <senf/Socket/ProtocolClientSocketHandle.hh>
 
 
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -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