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>,
  78           public IPv4Protocol,
  79           public RawINetProtocol,
  80           public BSDSocketProtocol,
  81           public AddressableBSDSocketProtocol,
  82           public MulticastProtocol,
  83           public INet4MulticastProtocol,
  84           public senf::pool_alloc_mixin<RawV4SocketProtocol>
  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         ///\name Abstract Interface Implementation
 108
 109         std::auto_ptr<SocketProtocol> clone() const;
 110
 111         ///@}
 112     };
 113
 114     typedef ProtocolClientSocketHandle<RawV4SocketProtocol> RawV4ClientSocketHandle;
 115
 116
 117
 118
 119 //////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
 120     typedef MakeSocketPolicy<
 121         INet6AddressingPolicy,
 122         DatagramFramingPolicy,
 123         UnconnectedCommunicationPolicy,
 124         ReadablePolicy,
 125         WriteablePolicy
 126         >::policy RawV6Socket_Policy;   ///< Socket Policy of the RawV6 Protocol
 127
 128     /** \brief IPv6 RAW Socket Protocol
 129
 130         \par Socket Handle typedefs:
 131         \ref RawV6ClientSocketHandle (ProtocolClientSocketHandle)
 132
 133         \par Policy Interface:
 134             ClientSocketHandle::read(), ClientSocketHandle::readfrom(),
 135             ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(),
 136             ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf()
 137
 138         \par Address Type:
 139             INet6Address
 140
 141         RawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing.
 142         This socket will put data written to it onto the IPv6 layer: if you call writeto don't inlude the header!
 143         On the other hand `read` will return the packet data on top of the IPv6 layer, excluding the IP header.
 144         Note: This behaviour is differs from the behaviour of IPv4 RAW sockets.
 145
 146         This class is utilized as the protocol class of the ProtocolClientSocketHandle
 147         via the Socket Handle typedefs above.
 148
 149         \see RawV4SocketProtocol
 150      */
 151     class RawV6SocketProtocol
 152         : public ConcreteSocketProtocol<RawV6Socket_Policy>,
 153           public IPv6Protocol,
 154           public RawINetProtocol,
 155           public BSDSocketProtocol,
 156           public AddressableBSDSocketProtocol,
 157           public MulticastProtocol,
 158           public INet4MulticastProtocol,
 159           public senf::pool_alloc_mixin<RawV6SocketProtocol>
 160     {
 161     public:
 162         ///////////////////////////////////////////////////////////////////////////
 163         // internal interface
 164
 165         ///\name Constructors
 166         ///@{
 167
 168         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
 169                                         /**< \note This member is implicitly called from the
 170                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 171                                              constructor */
 172
 173         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
 174
 175         void init_client(int const & protocol, INet6SocketAddress const & address) const;
 176                                         ///< Create client socket and bind
 177                                         /**< Creates a new client socket for the given protocol and binds to the given
 178                                              address.
 179                                              \param[in] protocol Layer 4 protocol to filter for / to send
 180                                              \param[in] address local address to bind to */
 181                                         /**< \note This member is implicitly called from the
 182                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 183                                              constructor */
 184
 185         ///@}
 186         ///\name Abstract Interface Implementation
 187
 188         std::auto_ptr<SocketProtocol> clone() const;
 189
 190         ///@}
 191     };
 192
 193     typedef ProtocolClientSocketHandle<RawV6SocketProtocol> RawV6ClientSocketHandle;
 194
 195     /// @}
 196
 197 }
 198
 199 #endif /*RAWINETSOCKETHANDLE_HH_*/