senf/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 CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  24 #define CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_
  25
  26 // Custom includes
  27 #include "INetSocketProtocol.hh"
  28 #include "RawINetSocketProtocol.hh"
  29 #include <senf/Socket/Protocols/BSDSocketProtocol.hh>
  30 #include <senf/Socket/Protocols/DatagramSocketProtocol.hh>
  31 #include <senf/Socket/FramingPolicy.hh>
  32 #include <senf/Socket/CommunicationPolicy.hh>
  33 #include <senf/Socket/ReadWritePolicy.hh>
  34 #include <senf/Socket/ProtocolClientSocketHandle.hh>
  35
  36
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40
  41     /// \addtogroup concrete_protocol_group
  42     /// @{
  43
  44     typedef MakeSocketPolicy<
  45         INet4AddressingPolicy,
  46         DatagramFramingPolicy,
  47         ConnectedCommunicationPolicy,
  48         ReadablePolicy,
  49         WriteablePolicy
  50         >::policy ConnectedRawV4Socket_Policy;   ///< Socket Policy of the Connected RawV4 Protocol
  51
  52     /** \brief IPv4 RAW Socket Protocol, connected
  53
  54         \par Socket Handle typedefs:
  55             \ref ConnectedRawV4ClientSocketHandle (ProtocolClientSocketHandle)
  56
  57         \par Policy Interface:
  58             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
  59             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer()
  60
  61         \par Address Type:
  62             INet4SocketAddress
  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         \attention
  73             If socket handle with ConnectedRawV4SocketProtocol is connected via INet4SocketAddress, the port number
  74             is interpreted as protocol number for IPv4 layer. Please refer manpage: "man 7 raw".
  75
  76         \see ConnectedRawV6SocketProtocol
  77         \see RawV4SocketProtocol
  78         \see RawV6SocketProtocol
  79      */
  80     class ConnectedRawV4SocketProtocol
  81         : public ConcreteSocketProtocol<ConnectedRawV4Socket_Policy, ConnectedRawV4SocketProtocol>,
  82           public RawINetSocketProtocol,
  83           public BSDSocketProtocol,
  84           public DatagramSocketProtocol,
  85           public AddressableBSDSocketProtocol
  86     {
  87     public:
  88         ///////////////////////////////////////////////////////////////////////////
  89         // internal interface
  90
  91         ///\name Constructors
  92         ///@{
  93
  94         void init_client() const;       ///< Create unconnected client socket for IPPROTO_RAW
  95                                         /**< \note This member is implicitly called from the
  96                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
  97                                              constructor */
  98         void init_client(int const & protocol) const;       ///< Create unconnected client socket for protocol
  99
 100         void init_client(int const & protocol, INet4SocketAddress const & address) const;
 101                                         ///< Create client socket and connect
 102                                         /**< Creates a new client socket for the given protocol and connects to the given
 103                                              address.
 104                                              \param[in] protocol Layer 4 protocol to filter for / to send
 105                                              \param[in] address local address to connect to */
 106
 107         ///@}
 108     };
 109
 110     typedef ProtocolClientSocketHandle<ConnectedRawV4SocketProtocol> ConnectedRawV4ClientSocketHandle;
 111
 112
 113
 114
 115 //////////////////////////////////////////////////////////////////// Raw IPv6 Socket //////////////////////////////////////
 116     typedef MakeSocketPolicy<
 117         INet6AddressingPolicy,
 118         DatagramFramingPolicy,
 119         ConnectedCommunicationPolicy,
 120         ReadablePolicy,
 121         WriteablePolicy
 122         >::policy ConnectedRawV6Socket_Policy;   ///< Socket Policy of the RawV6 Protocol
 123
 124     /** \brief IPv6 RAW Socket Protocol, connected
 125
 126         \par Socket Handle typedefs:
 127         \ref ConnectedRawV6ClientSocketHandle (ProtocolClientSocketHandle)
 128
 129         \par Policy Interface:
 130             ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(),
 131             ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer()
 132
 133         \par Address Type:
 134             INet6Address
 135
 136         ConnectedRawV6SocketProtocol provides an internet protocol raw socket based on IPv6 addressing which is connected to certain peer.
 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                 \attention
 145             If socket handle with ConnectedRawV6SocketProtocol is connected via INet6SocketAddress, the port number
 146             is interpreted as protocol number for IPv6 layer. Please refer manpage: "man 7 ipv6".
 147
 148         \see ConnectedRawV4SocketProtocol
 149         \see RawV4SocketProtocol
 150         \see RawV6SocketProtocol
 151      */
 152     class ConnectedRawV6SocketProtocol
 153         : public ConcreteSocketProtocol<ConnectedRawV6Socket_Policy, ConnectedRawV6SocketProtocol>,
 154           public RawINetSocketProtocol,
 155           public BSDSocketProtocol,
 156           public DatagramSocketProtocol,
 157           public AddressableBSDSocketProtocol
 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     };
 185
 186     typedef ProtocolClientSocketHandle<ConnectedRawV6SocketProtocol> ConnectedRawV6ClientSocketHandle;
 187
 188     /// @}
 189
 190 }
 191
 192 #endif /*CONNECTEDHH_SENF_Socket_Protocols_INet_RawINetSocketHandle_*/