senf/Socket/Protocols/INet/INetSocketProtocol.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief IPv[46]Protocol public header
  30
  31     \todo what about OOB data?
  32
  33     \todo Implement IP_RECVERR / MSG_ERRQUEUE. This should be placed
  34     into an additional protocol facet since IP_RECVERR is only valid
  35     for SOCK_DGRAM (UDP) and not SOCK_STREAM (TCP) sockets
  36  */
  37
  38 #ifndef HH_SENF_Socket_Protocols_INet_INetSocketProtocol_
  39 #define HH_SENF_Socket_Protocols_INet_INetSocketProtocol_ 1
  40
  41 // Custom includes
  42 #include <senf/Socket/SocketProtocol.hh>
  43
  44 //#include "INetSocketProtocol.mpp"
  45 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  46
  47 namespace senf {
  48
  49     /// \addtogroup protocol_facets_group
  50     //\{
  51
  52     /** \brief Generic addressing type independent INet protocol facet
  53      */
  54     class INetSocketProtocol
  55         : public virtual SocketProtocol
  56     {
  57     public:
  58         void bindInterface(std::string const & iface) const;
  59                                         ///< Bind socket to specific interface
  60                                         /**< When a socket is bound to an interface, it will only
  61                                              receive data received on that interface. If the
  62                                              interface name is empty, the binding is removed.
  63
  64                                              \param[in] iface name of interface to bind to or empty
  65                                                  to remove binding
  66
  67                                              \implementation Sets the SO_BINDTODEVICE socket option
  68                                           */
  69         std::string bindInterface();    ///< Get bound interface
  70                                         /**< Returns the interface, the socket is currently bound
  71                                              to. Returns the empty string, if not bound to any
  72                                              interface.
  73                                              \returns Bound interface name */
  74     };
  75
  76     //\}
  77
  78 }
  79
  80 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  81 //#include "INetSocketProtocol.cci"
  82 //#include "INetSocketProtocol.ct"
  83 //#include "INetSocketProtocol.cti"
  84 #endif
  85
  86 \f
  87 // Local Variables:
  88 // mode: c++
  89 // fill-column: 100
  90 // c-file-style: "senf"
  91 // indent-tabs-mode: nil
  92 // ispell-local-dictionary: "american"
  93 // compile-command: "scons -u test"
  94 // comment-column: 40
  95 // End: