senf/Socket/Protocols/INet/RawINetSocketHandle.hh

   1 // $Id: RawINetSocketHandle.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 HH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  24 #define HH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  25
  26
  27 // Custom includes
  28 #include "INetSocketProtocol.hh"
  29 #include "RawINetSocketProtocol.hh"
  30 #include "MulticastSocketProtocol.hh"
  31 #include "../../../Socket/Protocols/BSDSocketProtocol.hh"
  32 #include "../../../Socket/Protocols/DatagramSocketProtocol.hh"
  33 #include "../../../Socket/FramingPolicy.hh"
  34 #include "../../../Socket/CommunicationPolicy.hh"
  35 #include "../../../Socket/ReadWritePolicy.hh"
  36 #include "../../../Socket/ProtocolClientSocketHandle.hh"
  37
  38
  39 ///////////////////////////////hh.p////////////////////////////////////////
  40
  41 namespace senf {
  42
  43     /// \addtogroup concrete_protocol_group
  44     /// @{
  45
  46     typedef MakeSocketPolicy<
  47         INet4AddressingPolicy,
  48         DatagramFramingPolicy,
  49         UnconnectedCommunicationPolicy,
  50         ReadablePolicy,
  51         WriteablePolicy
  52         >::policy RawV4Socket_Policy;   ///< Socket Policy of the RawV4 Protocol
  53
  54     /** \brief IPv4 RAW Socket Protocol
  55
  56         \par Socket Handle typedefs:
  57             \ref RawV4ClientSocketHandle (ProtocolClientSocketHandle)
  58
  59         \par Policy Interface:
  60             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
  61             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
  62
  63         \par Address Type:
  64             INet4SocketAddress
  65
  66         RawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing.
  67         This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header!
  68         On the other hand `read` will return the packet data including the IP header.
  69         This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future.
  70
  71         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  72         via the Socket Handle typedefs above.
  73
  74         \see RawV6SocketProtocol
  75      */
  76     class RawV4SocketProtocol
  77         : public ConcreteSocketProtocol<RawV4Socket_Policy, RawV4SocketProtocol>,
  78           public RawINetSocketProtocol,
  79           public BSDSocketProtocol,
  80           public AddressableBSDSocketProtocol,
  81           public DatagramSocketProtocol,
  82           public INet4MulticastSocketProtocol
  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 bind
  99                                         /**< Creates a new client socket for the given protocol and binds to the given
 100                                              address.
 101                                              \param[in] protocol Layer 4 protocol to filter for / to send
 102                                              \param[in] address local address to bind to */
 103
 104         ///@}
 105     };
 106
 107     typedef ProtocolClientSocketHandle<RawV4SocketProtocol> RawV4ClientSocketHandle;
 108
 109
 110
 111
 112 //////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
 113     typedef MakeSocketPolicy<
 114         INet6AddressingPolicy,
 115         DatagramFramingPolicy,
 116         UnconnectedCommunicationPolicy,
 117         ReadablePolicy,
 118         WriteablePolicy
 119         >::policy RawV6Socket_Policy;   ///< Socket Policy of the RawV6 Protocol
 120
 121     /** \brief IPv6 RAW Socket Protocol
 122
 123         \par Socket Handle typedefs:
 124         \ref RawV6ClientSocketHandle (ProtocolClientSocketHandle)
 125
 126         \par Policy Interface:
 127             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
 128             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local()
 129
 130         \par Address Type:
 131             INet6Address
 132
 133         RawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing.
 134         This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header!
 135         On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header.
 136         Note: This behaviour is differs from the behaviour of IPv4 RAW sockets.
 137
 138         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 139         via the Socket Handle typedefs above.
 140
 141         \see RawV4SocketProtocol
 142      */
 143     class RawV6SocketProtocol
 144         : public ConcreteSocketProtocol<RawV6Socket_Policy,RawV6SocketProtocol>,
 145           public RawINetSocketProtocol,
 146           public BSDSocketProtocol,
 147           public AddressableBSDSocketProtocol,
 148           public DatagramSocketProtocol,
 149           public INet6MulticastSocketProtocol
 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 bind
 167                                         /**< Creates a new client socket for the given protocol and binds to the given
 168                                              address.
 169                                              \param[in] protocol Layer 4 protocol to filter for / to send
 170                                              \param[in] address local address to bind to */
 171                                         /**< \note This member is implicitly called from the
 172                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 173                                              constructor */
 174
 175         ///@}
 176     };
 177
 178     typedef ProtocolClientSocketHandle<RawV6SocketProtocol> RawV6ClientSocketHandle;
 179
 180     /// @}
 181
 182 }
 183
 184 #endif /*HH_SENF_Socket_Protocols_INet_RawINetSocketHandle_*/