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