X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FTCPSocketHandle.hh;h=aa60a840830287d5ee10c86b0a5ce7f9ff111b17;hb=9a988902090d28007578e93bffd809f6bd913155;hp=a566d939864f90517bfbabefeebc85bd71f2fa30;hpb=5a5c6d7f0fae7ad6c0af49d7742955cb6cf618cf;p=senf.git

diff --git a/Socket/TCPSocketHandle.hh b/Socket/TCPSocketHandle.hh
index a566d93..aa60a84 100644
--- a/Socket/TCPSocketHandle.hh
+++ b/Socket/TCPSocketHandle.hh
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2006 
+// Copyright (C) 2006
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
@@ -21,6 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
+    \brief TCPv4SocketHandle and TCPv6SocketHandle public header
 
     \todo Implement possibly non-blocking connect and SO_ERROR in the
     protocol interface
@@ -57,11 +58,31 @@ namespace senf {
         SocketBufferingPolicy
         >::policy TCPv4Socket_Policy;   ///< Socket Policy of the TCPv4 Protocol
 
-    /** \brief
+    /** \brief IPv4 TCP Socket Protocol
+
+        \par Socket Handle typedefs:
+        \ref TCPv4ClientSocketHandle (ProtocolClientSocketHandle), \ref TCPv4ServerSocketHandle
+        (ProtocolServerSocketHandle)
+
+        \par Policy Interface:
+        ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
+        ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
+        ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
+
+        \par Address Type:
+        INet4Address
+
+        TCPv4SocketProtocol provides an internet protocol stream socket based on the TCP protocol
+        and IPv4 addressing.
+
+        This class is utilized as the protocol class of the ProtocolClientSocketHandle and
+        ProtocolServerSocketHandle via the Socket Handle typedefs above.
+
+        \see TCPv6SocketProtocol
      */
     class TCPv4SocketProtocol
         : public ConcreteSocketProtocol<TCPv4Socket_Policy>,
-          public IPv4Protocol, 
+          public IPv4Protocol,
           public TCPProtocol,
           public BSDSocketProtocol,
           public AddressableBSDSocketProtocol
@@ -70,20 +91,44 @@ namespace senf {
         ///////////////////////////////////////////////////////////////////////////
         // internal interface
 
-	///\name Constructors
-	///@{
+        ///\name Constructors
+        ///@{
 
-        void init_client() const;
+        void init_client() const;       ///< Create unconnected client socket
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolClientSocketHandle::ProtocolClientSocketHandle()
+                                             constructor */
         void init_client(INet4Address const & address) const;
-        void init_server() const;
+                                        ///< Create client socket and connect
+                                        /**< Creates a new client socket and connects to the given
+                                             address.
+
+                                             \param[in] address remote address to connect to */
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolClientSocketHandle::ProtocolClientSocketHandle()
+                                             constructor */
+        void init_server() const;       ///< Create server socket
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolServerSocketHandle::ProtocolServerSocketHandle()
+                                             constructor */
         void init_server(INet4Address const & address, unsigned backlog=1) const;
+                                        ///< Create server socket and listen
+                                        /**< Creates a new server socket, binds to \a address end
+                                             starts listening for new connections with a backlog of
+                                             \a backlog connections. It also enables reuseaddr().
 
-	///@}
-	///\name Abstract Interface Implementation
+                                             \param[in] address address to listen on
+                                             \param[in] backlog size of the listen backlog */
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolServerSocketHandle::ProtocolServerSocketHandle()
+                                             constructor */
+
+        ///@}
+        ///\name Abstract Interface Implementation
 
         std::auto_ptr<SocketProtocol> clone() const;
-	
-	///@}
+
+        ///@}
     };
 
     typedef ProtocolClientSocketHandle<TCPv4SocketProtocol> TCPv4ClientSocketHandle;
@@ -94,14 +139,77 @@ namespace senf {
         INet6AddressingPolicy
         >::policy TCPv6Socket_Policy;
 
+    /** \brief IPv6 TCP Socket Protocol
+
+        \par Socket Handle typedefs:
+        \ref TCPv6ClientSocketHandle (ProtocolClientSocketHandle), \ref TCPv6ServerSocketHandle
+        (ProtocolServerSocketHandle)
+
+        \par Policy Interface:
+        ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
+        ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
+        ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
+
+        \par Address Type:
+        INet6Address
+
+        TCPv6SocketProtocol provides an internet protocol stream socket based on the TCP protocol
+        and IPv6 addressing.
+
+        This class is utilized as the protocol class of the ProtocolClientSocketHandle and
+        ProtocolServerSocketHandle via the Socket Handle typedefs above.
+
+        \see TCPv4SocketProtocol
+     */
     class TCPv6SocketProtocol
-        : public ConcreteSocketProtocol<TCPv6Socket_Policy>, 
+        : public ConcreteSocketProtocol<TCPv6Socket_Policy>,
           public IPv6Protocol,
           public TCPProtocol,
           public BSDSocketProtocol,
           public AddressableBSDSocketProtocol
     {
-        /** \todo Implement */
+    public:
+        ///////////////////////////////////////////////////////////////////////////
+        // internal interface
+
+        ///\name Constructors
+        ///@{
+
+        void init_client() const;       ///< Create unconnected client socket
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolClientSocketHandle::ProtocolClientSocketHandle()
+                                             constructor */
+        void init_client(INet6SocketAddress const & address) const;
+                                        ///< Create client socket and connect
+                                        /**< Creates a new client socket and connects to the given
+                                             address.
+
+                                             \param[in] address remote address to connect to */
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolClientSocketHandle::ProtocolClientSocketHandle()
+                                             constructor */
+        void init_server() const;       ///< Create server socket
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolServerSocketHandle::ProtocolServerSocketHandle()
+                                             constructor */
+        void init_server(INet6SocketAddress const & address, unsigned backlog=1) const;
+                                        ///< Create server socket and listen
+                                        /**< Creates a new server socket, binds to \a address end
+                                             starts listening for new connections with a backlog of
+                                             \a backlog connections. It also enables reuseaddr().
+
+                                             \param[in] address address to listen on
+                                             \param[in] backlog size of the listen backlog */
+                                        /**< \note This member is implicitly called from the
+                                             ProtocolServerSocketHandle::ProtocolServerSocketHandle()
+                                             constructor */
+
+        ///@}
+        ///\name Abstract Interface Implementation
+
+        std::auto_ptr<SocketProtocol> clone() const;
+
+        ///@}
     };
 
     typedef ProtocolClientSocketHandle<TCPv6SocketProtocol> TCPv6ClientSocketHandle;
@@ -120,5 +228,8 @@ namespace senf {
 
 // Local Variables:
 // mode: c++
+// fill-column: 100
 // c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
 // End: