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 RAWINETSOCKETHANDLE_HH_
  24 #define RAWINETSOCKETHANDLE_HH_
  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             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
  63
  64         \par Address Type:
  65             INet4Address
  66
  67         RawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing.
  68         This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header!
  69         On the other hand `read` will return the packet data including the IP header.
  70         This behaviour is strange and differs from the behaviour of IPv6 RAW sockets and should be changed in the future.
  71
  72         This class is utilized as the protocol class of the ProtocolClientSocketHandle
  73         via the Socket Handle typedefs above.
  74
  75         \see RawV6SocketProtocol
  76      */
  77     class RawV4SocketProtocol
  78         : public ConcreteSocketProtocol<RawV4Socket_Policy, RawV4SocketProtocol>,
  79           public RawINetSocketProtocol,
  80           public BSDSocketProtocol,
  81           public AddressableBSDSocketProtocol,
  82           public DatagramSocketProtocol,
  83           public MulticastSocketProtocol,
  84           public INet4MulticastSocketProtocol
  85     {
  86     public:
  87         ///////////////////////////////////////////////////////////////////////////
  88         // internal interface
  89
  90         ///\name Constructors
  91         ///@{
  92
  93         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
  94                                         /**< \note This member is implicitly called from the
  95                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  96                                              constructor */
  97         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
  98
  99         void init_client(int const & protocol, INet4SocketAddress const & address) const;
 100                                         ///< Create client socket and bind
 101                                         /**< Creates a new client socket for the given protocol and binds to the given
 102                                              address.
 103                                              \param[in] protocol Layer 4 protocol to filter for / to send
 104                                              \param[in] address local address to bind to */
 105
 106         ///@}
 107     };
 108
 109     typedef ProtocolClientSocketHandle<RawV4SocketProtocol> RawV4ClientSocketHandle;
 110
 111
 112
 113
 114 //////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
 115     typedef MakeSocketPolicy<
 116         INet6AddressingPolicy,
 117         DatagramFramingPolicy,
 118         UnconnectedCommunicationPolicy,
 119         ReadablePolicy,
 120         WriteablePolicy
 121         >::policy RawV6Socket_Policy;   ///< Socket Policy of the RawV6 Protocol
 122
 123     /** \brief IPv6 RAW Socket Protocol
 124
 125         \par Socket Handle typedefs:
 126         \ref RawV6ClientSocketHandle (ProtocolClientSocketHandle)
 127
 128         \par Policy Interface:
 129             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
 130             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
 131             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
 132
 133         \par Address Type:
 134             INet6Address
 135
 136         RawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing.
 137         This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header!
 138         On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header.
 139         Note: This behaviour is differs from the behaviour of IPv4 RAW sockets.
 140
 141         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 142         via the Socket Handle typedefs above.
 143
 144         \see RawV4SocketProtocol
 145      */
 146     class RawV6SocketProtocol
 147         : public ConcreteSocketProtocol<RawV6Socket_Policy,RawV6SocketProtocol>,
 148           public RawINetSocketProtocol,
 149           public BSDSocketProtocol,
 150           public AddressableBSDSocketProtocol,
 151           public DatagramSocketProtocol,
 152           public MulticastSocketProtocol,
 153           public INet6MulticastSocketProtocol
 154     {
 155     public:
 156         ///////////////////////////////////////////////////////////////////////////
 157         // internal interface
 158
 159         ///\name Constructors
 160         ///@{
 161
 162         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
 163                                         /**< \note This member is implicitly called from the
 164                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 165                                              constructor */
 166
 167         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
 168
 169         void init_client(int const & protocol, INet6SocketAddress const & address) const;
 170                                         ///< Create client socket and bind
 171                                         /**< Creates a new client socket for the given protocol and binds to the given
 172                                              address.
 173                                              \param[in] protocol Layer 4 protocol to filter for / to send
 174                                              \param[in] address local address to bind to */
 175                                         /**< \note This member is implicitly called from the
 176                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 177                                              constructor */
 178
 179         ///@}
 180     };
 181
 182     typedef ProtocolClientSocketHandle<RawV6SocketProtocol> RawV6ClientSocketHandle;
 183
 184     /// @}
 185
 186 }
 187
 188 #endif /*RAWINETSOCKETHANDLE_HH_*/