Socket/PacketSocketHandle.hh

   1 // $Id:PacketSocketHandle.hh 218 2007-03-20 14:39:32Z tho $
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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 /** \file
  24     \brief PacketProtocol and PacketSocketHandle public header
  25
  26     \todo Implement global promisc() helper based on ioctl() interface.
  27  */
  28
  29 #ifndef HH_PacketSocketHandle_
  30 #define HH_PacketSocketHandle_ 1
  31
  32 // Custom includes
  33 #include "SocketPolicy.hh"
  34 #include "SocketProtocol.hh"
  35 #include "ProtocolClientSocketHandle.hh"
  36 #include "LLAddressing.hh"
  37 #include "FramingPolicy.hh"
  38 #include "CommunicationPolicy.hh"
  39 #include "ReadWritePolicy.hh"
  40 #include "BufferingPolicy.hh"
  41 #include "BSDSocketProtocol.hh"
  42
  43 //#include "PacketSocketHandle.mpp"
  44 #include "PacketSocketHandle.ih"
  45 ///////////////////////////////hh.p////////////////////////////////////////
  46
  47 namespace senf {
  48
  49     /// \addtogroup concrete_protocol_group
  50     /// @{
  51
  52     typedef MakeSocketPolicy<
  53         LLAddressingPolicy,
  54         DatagramFramingPolicy,
  55         UnconnectedCommunicationPolicy,
  56         ReadablePolicy,
  57         WriteablePolicy,
  58         SocketBufferingPolicy
  59         >::policy Packet_Policy;        ///< Policy of PacketProtocol
  60
  61     /** \brief Raw Packet-Socket access (Linux)
  62
  63         \par Socket Handle typedefs:
  64         \ref PacketSocketHandle (ProtocolClientSocketHandle)
  65
  66         \par Policy Interface:
  67         ClientSocketHandle::read(), ClientSocketHandle::readfrom(), ClientSocketHandle::writeto(),
  68         ClientSocketHandle::bind(), ClientSocketHandle::local(), ClientSocketHandle::rcvbuf(),
  69         ClientSocketHandle::sndbuf()
  70
  71         \par Address Type:
  72         LLSocketAddress
  73
  74         The PacketProtocol provides access to the linux packet socket API. This API gives access to
  75         the low level network packets. The packet socket allows read() and write() operations. The
  76         PacketProtocol has no concept of a server socket.
  77
  78         This class is utilized as the protocol class of the ProtocolClientSocketHandle via the
  79         Socket Handle typedefs above.
  80      */
  81     class PacketProtocol
  82         : public ConcreteSocketProtocol<Packet_Policy>,
  83           public BSDSocketProtocol
  84     {
  85     public:
  86         enum SocketType { RawSocket, DatagramSocket };
  87                                         ///< Socket types
  88
  89         ///\name Constructors
  90         ///@{
  91         void init_client(SocketType type = RawSocket, int protocol = -1) const;
  92                                         ///< Create packet socket
  93                                         /**< The new socket will receive all packets of the given
  94                                              IEEE 802.3 \a protocol. The socket will receive all
  95                                              packets, if \a protocol is -1.
  96
  97                                              If \a type is \c RawSocket, the packet will include the
  98                                              link-level header (the Ethernet header). Sent packets
  99                                              must already include a well formed ll header.
 100
 101                                              If \a type is \c DatagramSocket, the link level header
 102                                              will not be part of the packet data. The ll header will
 103                                              be removed from received packets and a correct ll
 104                                              header will be created on sent packets.
 105
 106                                              \param[in] type socket type
 107                                              \param[in] protocol IEEE 802.3 protocol number */
 108                                         /**< \note This member is implicitly called from the
 109                                              ProtocolClientSocketHandle::ProtocolClientSocketHandle()
 110                                              constructor */
 111         ///@}
 112
 113         ///\name Protocol Interface
 114         ///@{
 115
 116         // See LLSocketAddress for a discussion/rationale for ForwardRange here
 117         template <class ForwardRange>
 118         void mcAdd(std::string interface, ForwardRange const & address) const;
 119                                         ///< Enable reception of a multicast group
 120                                         /**< mcAdd will join a new multicast group. The address
 121                                              parameter is specified as an arbitrary forward range
 122                                              (see <a
 123                                              href="http://www.boost.org/libs/range/index.html">Boost.Range</a>)
 124                                              of up to 8 bytes. This  allows to initialize the
 125                                              address from an arbitrary sources without excessive
 126                                              copying.
 127
 128                                              \param[in] interface interface with which to join
 129                                              \param[in] address multicast address to join
 130
 131                                              \see \ref LLSocketAddress */
 132         template <class ForwardRange>
 133         void mcDrop(std::string interface, ForwardRange const & address) const;
 134                                         ///< Disable reception of a multicast group
 135                                         /**< \see \ref mcAdd() */
 136         ///@}
 137
 138         ///\name Abstract Interface Implementation
 139         ///@{
 140
 141         std::auto_ptr<SocketProtocol> clone() const;
 142         unsigned available() const;
 143         bool eof() const;
 144
 145         ///@}
 146
 147     private:
 148         template<class ForwardRange>
 149         void do_mc(std::string interface, ForwardRange const & address, bool add) const;
 150         void do_mc_i(std::string interface, detail::LLAddressCopier const & copier, bool add) const;
 151     };
 152
 153     typedef ProtocolClientSocketHandle<PacketProtocol> PacketSocketHandle;
 154                                         ///< SocketHandle of the PacketProtocol
 155                                         /**< \related PacketPrototol */
 156
 157     /// @}
 158 }
 159
 160 ///////////////////////////////hh.e////////////////////////////////////////
 161 //#include "PacketSocketHandle.cci"
 162 #include "PacketSocketHandle.ct"
 163 #include "PacketSocketHandle.cti"
 164 //#include "PacketSocketHandle.mpp"
 165 #endif
 166
 167 \f
 168 // Local Variables:
 169 // mode: c++
 170 // fill-column: 100
 171 // c-file-style: "senf"
 172 // indent-tabs-mode: nil
 173 // ispell-local-dictionary: "american"
 174 // compile-command: "scons -u test"
 175 // End: