senf/Socket/Protocols/UN/UNDatagramSocketHandle.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   David Wagner <dw6@berlios.de>
  27 /** \file
  28     \brief UNDatagramSocketHandle public header */
  29
  30 #ifndef HH_SENF_Socket_Protocols_UN_UNDatagramSocketHandle_
  31 #define HH_SENF_Socket_Protocols_UN_UNDatagramSocketHandle_ 1
  32
  33 // Custom includes
  34 #include "UNAddressing.hh"
  35 #include "UNSocketProtocol.hh"
  36 #include <senf/Socket/Protocols/BSDSocketProtocol.hh>
  37 #include <senf/Socket/FramingPolicy.hh>
  38 #include <senf/Socket/CommunicationPolicy.hh>
  39 #include <senf/Socket/ReadWritePolicy.hh>
  40 #include <senf/Socket/ProtocolClientSocketHandle.hh>
  41
  42 //#include "UNDatagramSocketHandle.mpp"
  43 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  44
  45 namespace senf {
  46
  47     /// \addtogroup concrete_protocol_group
  48     //\{
  49
  50     typedef MakeSocketPolicy<
  51         UNAddressingPolicy,
  52         DatagramFramingPolicy,
  53         UnconnectedCommunicationPolicy,
  54         ReadablePolicy,
  55         WriteablePolicy
  56         >::policy UNDatagramSocket_Policy;   ///< Socket Policy of the Unix Domain Datagram Protocol
  57
  58     /** \brief Unix Domain Datagram Socket Protocol
  59
  60         \par Socket Handle typedefs:
  61             \ref UNDatagramClientSocketHandle (ProtocolClientSocketHandle)
  62
  63         \par Policy Interface: (to be checked)
  64             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
  65             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
  66
  67         \par Address Type:
  68             UNSocketAddress
  69
  70         UNDatagramSocketProtocol provides an datagram protocol socket based on the unix domain
  71         addressing.
  72
  73         This class is utilized as the protocol class of the ProtocolClientSocketHandle via the
  74         Socket Handle typedefs above.
  75     */
  76     class UNDatagramSocketProtocol
  77         : public ConcreteSocketProtocol<UNDatagramSocket_Policy,
  78                                         UNDatagramSocketProtocol>,
  79           public UNSocketProtocol,
  80           public BSDSocketProtocol,
  81           public AddressableBSDSocketProtocol
  82     {
  83     public:
  84         //-////////////////////////////////////////////////////////////////////////
  85         // internal interface
  86
  87         ///\name Constructors
  88         //\{
  89
  90         void init_client() const;       ///< Create unconnected client socket
  91                                         /**< \note This member is implicitly called from the
  92                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  93                                              constructor */
  94         void init_client(UNSocketAddress const & address) const;
  95                                         ///< Create client socket and bind
  96                                         /**< Creates a new client socket and bind to the given
  97                                              address.
  98                                              \param[in] address local address to bind to */
  99                                         /**< \note This member is implicitly called from the
 100                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 101                                              constructor */
 102
 103         //\}
 104     };
 105
 106     typedef ProtocolClientSocketHandle<UNDatagramSocketProtocol> UNDatagramClientSocketHandle;
 107
 108     //\}
 109
 110 }
 111 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 112 //#include "UNDatagramSocketHandle.cci"
 113 //#include "UNDatagramSocketHandle.ct"
 114 //#include "UNDatagramSocketHandle.cti"
 115 #endif
 116
 117 \f
 118 // Local Variables:
 119 // mode: c++
 120 // fill-column: 100
 121 // comment-column: 40
 122 // c-file-style: "senf"
 123 // indent-tabs-mode: nil
 124 // ispell-local-dictionary: "american"
 125 // compile-command: "scons -u test"
 126 // End: