Socket/Protocols/INet/ConnectedUDPSocketHandle.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_ConnectedUDPSocketHandle_
  31 #define HH_ConnectedUDPSocketHandle_ 1
  32
  33 // Custom includes
  34 #include "INetProtocol.hh"
  35 #include "UDPProtocol.hh"
  36 #include "../../../Socket/Protocols/BSDSocketProtocol.hh"
  37 #include "../../../Socket/FramingPolicy.hh"
  38 #include "../../../Socket/CommunicationPolicy.hh"
  39 #include "../../../Socket/ReadWritePolicy.hh"
  40 #include "../../../Socket/ProtocolClientSocketHandle.hh"
  41
  42 //#include "ConnectedUDPSocketHandle.mpp"
  43 ///////////////////////////////hh.p////////////////////////////////////////
  44
  45 namespace senf {
  46
  47     /// \addtogroup concrete_protocol_group
  48     /// @{
  49
  50     typedef MakeSocketPolicy<
  51         INet4AddressingPolicy,
  52         DatagramFramingPolicy,
  53         ConnectedCommunicationPolicy,
  54         ReadablePolicy,
  55         WriteablePolicy
  56         >::policy ConnectedUDPv4Socket_Policy;   ///< Socket Policy of the UDPv4 Protocol
  57
  58     /** \brief IPv4 UDP Socket Protocol, connected
  59
  60         \par Socket Handle typedefs:
  61             \ref ConnectedUDPv4ClientSocketHandle (ProtocolClientSocketHandle)
  62
  63         \par Policy Interface:
  64             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
  65             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
  66             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
  67
  68         \par Address Type:
  69             INet4Address
  70
  71         ConnectedUDPv4SocketProtocol provides an internet protocol stream socket based on the UDP
  72         protocol and IPv4 addressing.
  73
  74         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  75         via the Socket Handle typedefs above.
  76
  77         \see ConnectedUDPv6SocketProtocol
  78      */
  79     class ConnectedUDPv4SocketProtocol
  80         : public ConcreteSocketProtocol<ConnectedUDPv4Socket_Policy, ConnectedUDPv4SocketProtocol>,
  81           public IPv4Protocol,
  82           public UDPProtocol,
  83           public BSDSocketProtocol,
  84           public AddressableBSDSocketProtocol
  85     {
  86     public:
  87         ///////////////////////////////////////////////////////////////////////////
  88         // internal interface
  89
  90         ///\name Constructors
  91         ///@{
  92
  93         void init_client() const;       ///< Create unconnected client socket
  94                                         /**< \note This member is implicitly called from the
  95                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  96                                              constructor */
  97         void init_client(INet4SocketAddress const & address) const;
  98                                         ///< Create client socket and connect
  99                                         /**< Creates a new client socket and connects to the given
 100                                              address.
 101
 102                                              \param[in] address remote address to connect to */
 103                                         /**< \note This member is implicitly called from the
 104                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 105                                              constructor */
 106
 107         ///@}
 108     };
 109
 110     typedef ProtocolClientSocketHandle<
 111         ConnectedUDPv4SocketProtocol> ConnectedUDPv4ClientSocketHandle;
 112
 113     typedef MakeSocketPolicy<
 114         ConnectedUDPv4Socket_Policy,
 115         INet6AddressingPolicy
 116         >::policy  ConnectedUDPv6Socket_Policy;
 117
 118     /** \brief IPv6 UDP Socket Protocol, connected
 119
 120         \par Socket Handle typedefs:
 121             \ref ConnectedUDPv6ClientSocketHandle (ProtocolClientSocketHandle)
 122
 123         \par Policy Interface:
 124             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
 125             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(),
 126             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
 127
 128         \par Address Type:
 129             INet6Address
 130
 131         ConnectedUDPv6SocketProtocol provides an internet protocol stream socket based on the UDP
 132         protocol and IPv6 addressing.
 133
 134         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 135         via the Socket Handle typedefs above.
 136
 137         \see ConnectedUDPv4SocketProtocol
 138      */
 139     class ConnectedUDPv6SocketProtocol
 140         : public ConcreteSocketProtocol<ConnectedUDPv6Socket_Policy, ConnectedUDPv6SocketProtocol>,
 141           public IPv6Protocol,
 142           public UDPProtocol,
 143           public BSDSocketProtocol,
 144           public AddressableBSDSocketProtocol
 145     {
 146     public:
 147         ///////////////////////////////////////////////////////////////////////////
 148         // internal interface
 149
 150         ///\name Constructors
 151         ///@{
 152
 153         void init_client() const;       ///< Create unconnected client socket
 154                                         /**< \note This member is implicitly called from the
 155                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 156                                              constructor */
 157         void init_client(INet6SocketAddress const & address) const;
 158                                         ///< Create client socket and connect
 159                                         /**< Creates a new client socket and connects to the given
 160                                              address.
 161
 162                                              \param[in] address remote address to connect to */
 163                                         /**< \note This member is implicitly called from the
 164                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 165                                              constructor */
 166
 167         ///@}
 168     };
 169
 170     typedef ProtocolClientSocketHandle<
 171         ConnectedUDPv6SocketProtocol> ConnectedUDPv6ClientSocketHandle;
 172
 173     /// @}
 174
 175 }
 176
 177 ///////////////////////////////hh.e////////////////////////////////////////
 178 //#include "ConnectedUDPSocketHandle.cci"
 179 //#include "ConnectedUDPSocketHandle.ct"
 180 //#include "ConnectedUDPSocketHandle.cti"
 181 #endif
 182
 183 \f
 184 // Local Variables:
 185 // mode: c++
 186 // fill-column: 100
 187 // c-file-style: "senf"
 188 // indent-tabs-mode: nil
 189 // ispell-local-dictionary: "american"
 190 // compile-command: "scons -u test"
 191 // comment-column: 40
 192 // End: