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