Socket/Protocols/UN/ConnectedUNDatagramSocketHandle.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     David Wagner <dw6@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief ConnectedUNDatagramSocketHandle public header */
  25
  26 #ifndef CONNECTEDUNDATAGRAMSOCKETHANDLE_HH_
  27 #define CONNECTEDUNDATAGRAMSOCKETHANDLE_HH_
  28
  29 // Custom includes
  30 #include "UNAddressing.hh"
  31 #include "UNProtocol.hh"
  32 #include "../../../Socket/Protocols/BSDSocketProtocol.hh"
  33 #include "../../../Socket/FramingPolicy.hh"
  34 #include "../../../Socket/CommunicationPolicy.hh"
  35 #include "../../../Socket/ReadWritePolicy.hh"
  36 #include "../../../Socket/BufferingPolicy.hh"
  37 #include "../../../Socket/ProtocolClientSocketHandle.hh"
  38
  39 //#include "UNDatagramSocketHandle.mpp"
  40 ///////////////////////////////hh.p////////////////////////////////////////
  41
  42 namespace senf {
  43
  44     /// \addtogroup concrete_protocol_group
  45     /// @{
  46
  47     typedef MakeSocketPolicy<
  48         UNAddressingPolicy,
  49         DatagramFramingPolicy,
  50         ConnectedCommunicationPolicy,
  51         ReadablePolicy,
  52         WriteablePolicy,
  53         SocketBufferingPolicy
  54         >::policy ConnectedUNDatagramSocket_Policy;   ///< Socket Policy of the Unix Domain Datagram Protocol (connected)
  55
  56     /** \brief Unix Domain Datagram Socket Protocol (connected)
  57
  58         \par Socket Handle typedefs:
  59             \ref ConnectedUNDatagramClientSocketHandle (ProtocolClientSocketHandle)
  60
  61         \par Policy Interface: (to be checked)
  62             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
  63             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
  64             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
  65
  66         \par Address Type:
  67             UNAddress
  68
  69         ConnectedUNDatagramSocketProtocol provides an datagram protocol socket based on the unix domain  addressing which operates in a connected mode.
  70
  71         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  72         via the Socket Handle typedefs above.
  73
  74     */
  75     class ConnectedUNDatagramSocketProtocol
  76         : public ConcreteSocketProtocol<ConnectedUNDatagramSocket_Policy>,
  77           public UNProtocol,
  78           public BSDSocketProtocol,
  79           public AddressableBSDSocketProtocol,
  80           public senf::pool_alloc_mixin<ConnectedUNDatagramSocketProtocol>
  81     {
  82     public:
  83         ///////////////////////////////////////////////////////////////////////////
  84         // internal interface
  85
  86         ///\name Constructors
  87         ///@{
  88
  89         void init_client() const;       ///< Create unconnected client socket
  90                                         /**< \note This member is implicitly called from the
  91                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  92                                              constructor */
  93         void init_client(UNSocketAddress const & address) const;
  94                                         ///< Create client socket and connect
  95                                         /**< Creates a new client socket and connects to the given
  96                                              address.
  97                                              \param[in] address peer address to connect to */
  98                                         /**< \note This member is implicitly called from the
  99                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 100                                              constructor */
 101
 102         ///@}
 103         ///\name Abstract Interface Implementation
 104
 105         std::auto_ptr<SocketProtocol> clone() const;
 106
 107         ///@}
 108     };
 109
 110     typedef ProtocolClientSocketHandle<ConnectedUNDatagramSocketProtocol> ConnectedUNDatagramClientSocketHandle;
 111
 112 }
 113
 114 #endif /*CONNECTEDUNDATAGRAMSOCKETHANDLE_HH_*/