Add 'include/senf' directory

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

diff --git a/Socket/Protocols/INet/UDPSocketHandle.hh b/Socket/Protocols/INet/UDPSocketHandle.hh
index 1a1e93d..46a7cb3 100644 (file)
--- a/Socket/Protocols/INet/UDPSocketHandle.hh
+++ b/Socket/Protocols/INet/UDPSocketHandle.hh
@@ -33,12 +33,12 @@
 // Custom includes
 #include "INetProtocol.hh"
 #include "UDPProtocol.hh"
-#include "Socket/Protocols/BSDSocketProtocol.hh"
-#include "Socket/FramingPolicy.hh"
-#include "Socket/CommunicationPolicy.hh"
-#include "Socket/ReadWritePolicy.hh"
-#include "Socket/BufferingPolicy.hh"
-#include "Socket/ProtocolClientSocketHandle.hh"
+#include "../../../Socket/Protocols/BSDSocketProtocol.hh"
+#include "../../../Socket/FramingPolicy.hh"
+#include "../../../Socket/CommunicationPolicy.hh"
+#include "../../../Socket/ReadWritePolicy.hh"
+#include "../../../Socket/BufferingPolicy.hh"
+#include "../../../Socket/ProtocolClientSocketHandle.hh"
 
 //#include "UDPSocketHandle.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -60,15 +60,15 @@ namespace senf {
     /** \brief IPv4 UDP Socket Protocol
 
         \par Socket Handle typedefs:
-        \ref UDPv4ClientSocketHandle (ProtocolClientSocketHandle)
+            \ref UDPv4ClientSocketHandle (ProtocolClientSocketHandle)
 
         \par Policy Interface:
-        ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
-        ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
-        ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
+            ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
+            ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
+            ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
 
         \par Address Type:
-        INet4Address
+            INet4Address
 
         UDPv4SocketProtocol provides an internet protocol stream socket based on the UDP protocol
         and IPv4 addressing.
@@ -97,12 +97,11 @@ namespace senf {
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
-        void init_client(INet4Address const & address) const;
-                                        ///< Create client socket and connect
-                                        /**< Creates a new client socket and connects to the given
+        void init_client(INet4SocketAddress const & address) const;
+                                        ///< Create client socket and bind
+                                        /**< Creates a new client socket and bind to the given
                                              address.
-
-                                             \param[in] address remote address to connect to */
+                                             \param[in] local address to bind to */
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */
@@ -127,13 +126,13 @@ namespace senf {
         \par Socket Handle typedefs:
         \ref UDPv6ClientSocketHandle (ProtocolClientSocketHandle)
 
-        \par Policy Interface:
-        ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
-        ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
-        ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
+        \par Policy Interface: 
+            ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
+            ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
+            ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
 
         \par Address Type:
-        INet6Address
+            INet6Address
 
         UDPv6SocketProtocol provides an internet protocol stream socket based on the UDP protocol
         and IPv6 addressing.
@@ -164,10 +163,9 @@ namespace senf {
                                              constructor */
         void init_client(INet6SocketAddress const & address) const;
                                         ///< Create client socket and connect
-                                        /**< Creates a new client socket and connects to the given
+                                        /**< Creates a new client socket and bind to the given
                                              address.
-
-                                             \param[in] address remote address to connect to */
+                                             \param[in] local address to bind to */
                                         /**< \note This member is implicitly called from the
                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
                                              constructor */