Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh

   1 // $Id: ConnectedRawINetSocketHandle.hh 597 2008-01-15 09:16:20Z g0dil $
   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 #ifndef CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  24 #define CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  25
  26 // Custom includes
  27 #include "INetSocketProtocol.hh"
  28 #include "RawINetSocketProtocol.hh"
  29 #include "../../../Socket/Protocols/BSDSocketProtocol.hh"
  30 #include "../../../Socket/Protocols/DatagramSocketProtocol.hh"
  31 #include "../../../Socket/FramingPolicy.hh"
  32 #include "../../../Socket/CommunicationPolicy.hh"
  33 #include "../../../Socket/ReadWritePolicy.hh"
  34 #include "../../../Socket/ProtocolClientSocketHandle.hh"
  35
  36
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40
  41     /// \addtogroup concrete_protocol_group
  42     /// @{
  43
  44     typedef MakeSocketPolicy<
  45         INet4AddressingPolicy,
  46         DatagramFramingPolicy,
  47         ConnectedCommunicationPolicy,
  48         ReadablePolicy,
  49         WriteablePolicy
  50         >::policy ConnectedRawV4Socket_Policy;   ///< Socket Policy of the Connected RawV4 Protocol
  51
  52     /** \brief IPv4 RAW Socket Protocol, connected
  53
  54         \par Socket Handle typedefs:
  55             \ref ConnectedRawV4ClientSocketHandle (ProtocolClientSocketHandle)
  56
  57         \par Policy Interface:
  58             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
  59             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer()
  60
  61         \par Address Type:
  62             INet4SocketAddress
  63
  64         ConnectedRawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing.
  65         This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header!
  66         On the other hand `read` will return the packet data including the IP header.
  67         This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future.
  68
  69         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  70         via the Socket Handle typedefs above.
  71
  72         \see ConnectedRawV6SocketProtocol
  73         \see RawV4SocketProtocol
  74         \see RawV6SocketProtocol
  75      */
  76     class ConnectedRawV4SocketProtocol
  77         : public ConcreteSocketProtocol<ConnectedRawV4Socket_Policy, ConnectedRawV4SocketProtocol>,
  78           public RawINetSocketProtocol,
  79           public BSDSocketProtocol,
  80           public DatagramSocketProtocol,
  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 for IPPROTO_RAW
  91                                         /**< \note This member is implicitly called from the
  92                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  93                                              constructor */
  94         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
  95
  96         void init_client(int const & protocol, INet4SocketAddress const & address) const;
  97                                         ///< Create client socket and connect
  98                                         /**< Creates a new client socket for the given protocol and connects to the given
  99                                              address.
 100                                              \param[in] protocol Layer 4 protocol to filter for / to send
 101                                              \param[in] address local address to connect to */
 102
 103         ///@}
 104     };
 105
 106     typedef ProtocolClientSocketHandle<ConnectedRawV4SocketProtocol> ConnectedRawV4ClientSocketHandle;
 107
 108
 109
 110
 111 //////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
 112     typedef MakeSocketPolicy<
 113         INet6AddressingPolicy,
 114         DatagramFramingPolicy,
 115         ConnectedCommunicationPolicy,
 116         ReadablePolicy,
 117         WriteablePolicy
 118         >::policy ConnectedRawV6Socket_Policy;   ///< Socket Policy of the RawV6 Protocol
 119
 120     /** \brief IPv6 RAW Socket Protocol, connected
 121
 122         \par Socket Handle typedefs:
 123         \ref ConnectedRawV6ClientSocketHandle (ProtocolClientSocketHandle)
 124
 125         \par Policy Interface:
 126             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
 127             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer()
 128
 129         \par Address Type:
 130             INet6Address
 131
 132         ConnectedRawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing which is connected to certain peer.
 133         This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header!
 134         On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header.
 135         Note: This behaviour is differs from the behaviour of IPv4 RAW sockets.
 136
 137         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 138         via the Socket Handle typedefs above.
 139
 140         \see ConnectedRawV4SocketProtocol
 141         \see RawV4SocketProtocol
 142         \see RawV6SocketProtocol
 143      */
 144     class ConnectedRawV6SocketProtocol
 145         : public ConcreteSocketProtocol<ConnectedRawV6Socket_Policy, ConnectedRawV6SocketProtocol>,
 146           public RawINetSocketProtocol,
 147           public BSDSocketProtocol,
 148           public DatagramSocketProtocol,
 149           public AddressableBSDSocketProtocol
 150     {
 151     public:
 152         ///////////////////////////////////////////////////////////////////////////
 153         // internal interface
 154
 155         ///\name Constructors
 156         ///@{
 157
 158         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
 159                                         /**< \note This member is implicitly called from the
 160                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 161                                              constructor */
 162
 163         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
 164
 165         void init_client(int const & protocol, INet6SocketAddress const & address) const;
 166                                         ///< Create client socket and connect
 167                                         /**< Creates a new client socket for the given protocol and connects to the given
 168                                              address.
 169                                              \param[in] protocol Layer 4 protocol to filter for / to send
 170                                              \param[in] address local address to connect to */
 171                                         /**< \note This member is implicitly called from the
 172                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 173                                              constructor (??) */
 174
 175         ///@}
 176     };
 177
 178     typedef ProtocolClientSocketHandle<ConnectedRawV6SocketProtocol> ConnectedRawV6ClientSocketHandle;
 179
 180     /// @}
 181
 182 }
 183
 184 #endif /*CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_*/