Implement senf::IGNORE and replace all casts-to-void with senf::IGNORE() calls
[senf.git] / senf / Socket / Protocols / INet / ConnectedRawINetSocketHandle.hh
index 0f63559..ad43e92 100644 (file)
 #define CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
 
 // Custom includes
-#include "INetSocketProtocol.hh"
+#include "INetAddressing.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////////////////////////////////////////
@@ -61,14 +61,20 @@ namespace senf {
         \par Address Type:
             INet4SocketAddress
 
-        ConnectedRawV4SocketProtocol 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!
+        ConnectedRawV4SocketProtocol 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 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. 
+        This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be 
+        changed in the future. 
 
         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 +143,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