Socket/Protocols/INet/UDPSocketHandle.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@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 UDPv4SocketHandle and UDPv6SocketHandle public header
  25
  26     \todo Implement possibly non-blocking connect and SO_ERROR in the
  27     protocol interface
  28  */
  29
  30 #ifndef HH_UDPSocketHandle_
  31 #define HH_UDPSocketHandle_ 1
  32
  33 // Custom includes
  34 #include "INetSocketProtocol.hh"
  35 #include "UDPSocketProtocol.hh"
  36 #include "MulticastSocketProtocol.hh"
  37 #include "../../../Socket/Protocols/BSDSocketProtocol.hh"
  38 #include "../../../Socket/Protocols/DatagramSocketProtocol.hh"
  39 #include "../../../Socket/FramingPolicy.hh"
  40 #include "../../../Socket/CommunicationPolicy.hh"
  41 #include "../../../Socket/ReadWritePolicy.hh"
  42 #include "../../../Socket/ProtocolClientSocketHandle.hh"
  43
  44 //#include "UDPSocketHandle.mpp"
  45 ///////////////////////////////hh.p////////////////////////////////////////
  46
  47 namespace senf {
  48
  49     /// \addtogroup concrete_protocol_group
  50     /// @{
  51
  52     typedef MakeSocketPolicy<
  53         INet4AddressingPolicy,
  54         DatagramFramingPolicy,
  55         UnconnectedCommunicationPolicy,
  56         ReadablePolicy,
  57         WriteablePolicy
  58         >::policy UDPv4Socket_Policy;   ///< Socket Policy of the UDPv4 Protocol
  59
  60     /** \brief IPv4 UDP Socket Protocol
  61
  62         \par Socket Handle typedefs:
  63             \ref UDPv4ClientSocketHandle (ProtocolClientSocketHandle)
  64
  65         \par Policy Interface:
  66             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
  67             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
  68
  69         \par Address Type:
  70             INet4SocketAddress
  71
  72         UDPv4SocketProtocol provides an internet protocol stream socket based on the UDP protocol
  73         and IPv4 addressing.
  74
  75         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  76         via the Socket Handle typedefs above.
  77
  78         \see UDPv6SocketProtocol
  79      */
  80     class UDPv4SocketProtocol
  81         : public ConcreteSocketProtocol<UDPv4Socket_Policy, UDPv4SocketProtocol>,
  82           public UDPSocketProtocol,
  83           public MulticastSocketProtocol,
  84           public INet4MulticastSocketProtocol,
  85           public BSDSocketProtocol,
  86           public DatagramSocketProtocol,
  87           public AddressableBSDSocketProtocol
  88     {
  89     public:
  90         ///////////////////////////////////////////////////////////////////////////
  91         // internal interface
  92
  93         ///\name Constructors
  94         ///@{
  95
  96         void init_client() const;       ///< Create unconnected client socket
  97                                         /**< \note This member is implicitly called from the
  98                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  99                                              constructor */
 100         void init_client(INet4SocketAddress const & address) const;
 101                                         ///< Create client socket and bind
 102                                         /**< Creates a new client socket and bind to the given
 103                                              address.
 104                                              \param[in] address local address to bind to */
 105                                         /**< \note This member is implicitly called from the
 106                                             ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 107                                              constructor */
 108
 109         ///@}
 110
 111     };
 112
 113     typedef ProtocolClientSocketHandle<UDPv4SocketProtocol> UDPv4ClientSocketHandle;
 114
 115     typedef MakeSocketPolicy<
 116         UDPv4Socket_Policy,
 117         INet6AddressingPolicy
 118         >::policy UDPv6Socket_Policy;
 119
 120     /** \brief IPv6 UDP Socket Protocol
 121
 122         \par Socket Handle typedefs:
 123         \ref UDPv6ClientSocketHandle (ProtocolClientSocketHandle)
 124
 125         \par Policy Interface:
 126             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
 127             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
 128
 129         \par Address Type:
 130             INet6Address
 131
 132         UDPv6SocketProtocol provides an internet protocol stream socket based on the UDP protocol
 133         and IPv6 addressing.
 134
 135         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 136         via the Socket Handle typedefs above.
 137
 138         \see UDPv4SocketProtocol
 139      */
 140     class UDPv6SocketProtocol
 141         : public ConcreteSocketProtocol<UDPv6Socket_Policy, UDPv6SocketProtocol>,
 142           public UDPSocketProtocol,
 143           public MulticastSocketProtocol,
 144           public INet6MulticastSocketProtocol,
 145           public BSDSocketProtocol,
 146           public DatagramSocketProtocol,
 147           public AddressableBSDSocketProtocol
 148     {
 149     public:
 150         ///////////////////////////////////////////////////////////////////////////
 151         // internal interface
 152
 153         ///\name Constructors
 154         ///@{
 155
 156         void init_client() const;       ///< Create unconnected client socket
 157                                         /**< \note This member is implicitly called from the
 158                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 159                                              constructor */
 160         void init_client(INet6SocketAddress const & address) const;
 161                                         ///< Create client socket and connect
 162                                         /**< Creates a new client socket and bind to the given
 163                                              address.
 164                                              \param[in] address local address to bind to */
 165                                         /**< \note This member is implicitly called from the
 166                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 167                                              constructor */
 168
 169         ///@}
 170     };
 171
 172     typedef ProtocolClientSocketHandle<UDPv6SocketProtocol> UDPv6ClientSocketHandle;
 173
 174     /// @}
 175
 176 }
 177
 178 ///////////////////////////////hh.e////////////////////////////////////////
 179 //#include "UDPSocketHandle.cci"
 180 //#include "UDPSocketHandle.ct"
 181 //#include "UDPSocketHandle.cti"
 182 #endif
 183
 184 \f
 185 // Local Variables:
 186 // mode: c++
 187 // fill-column: 100
 188 // c-file-style: "senf"
 189 // indent-tabs-mode: nil
 190 // ispell-local-dictionary: "american"
 191 // compile-command: "scons -u test"
 192 // comment-column: 40
 193 // End: