PPI/SocketWriter.hh

   1 // Copyright (C) 2007
   2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   3 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   4 //     Stefan Bund <g0dil@berlios.de>
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the
  18 // Free Software Foundation, Inc.,
  19 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 /** \file
  22     \brief SocketWriter public header */
  23
  24 #ifndef HH_SocketWriter_
  25 #define HH_SocketWriter_ 1
  26
  27 // Custom includes
  28 #include "Packets/Packets.hh"
  29 #include "Socket/ClientSocketHandle.hh"
  30 #include "Socket/SocketPolicy.hh"
  31 #include "Socket/ReadWritePolicy.hh"
  32 #include "Socket/FramingPolicy.hh"
  33 #include "Socket/CommunicationPolicy.hh"
  34 #include "Module.hh"
  35 #include "Connectors.hh"
  36
  37 //#include "SocketWriter.mpp"
  38 ///////////////////////////////hh.p////////////////////////////////////////
  39
  40 namespace senf {
  41 namespace ppi {
  42
  43     /** \brief Write helper for module::ActiveSocketWriter / module::PassiveSocketWriter
  44
  45         This write helper will write the packets completely as datagrams to the given socket.
  46      */
  47     class PacketWriter
  48     {
  49     public:
  50         typedef senf::ClientSocketHandle<
  51             senf::MakeSocketPolicy< senf::WriteablePolicy,
  52                                     senf::DatagramFramingPolicy,
  53                                     senf::ConnectedCommunicationPolicy>::policy > Handle;
  54                                         ///< Handle type supported by this writer
  55
  56         void operator()(Handle handle, Packet packet);
  57                                         ///< Write \a packet to \a handle
  58                                         /**< Write the complete \a packet as a datagram to \a
  59                                              handle.
  60                                              \param[in] handle Handle to write data to
  61                                              \param[in] packet Packet to write */
  62     };
  63
  64 }}
  65
  66 namespace senf {
  67 namespace ppi {
  68 namespace module {
  69
  70     /** \brief Output module writing data to arbitrary FileHandle
  71
  72         This output module will write data to a FileHandle object using a given \a Writer. This
  73         output module is active. This requires the file handle to be able to signal its readiness to
  74         accept more data via the Scheduler.
  75
  76         The \a Writer must fulfill the following interface:
  77         \code
  78           class SomeWriter
  79           {
  80           public:
  81               typedef unspecified Handle;                          // type of handle requested
  82               SomeWriter();                                        // default constructible
  83               void operator()(Handle handle, Packet packet);       // insertion function
  84           };
  85         \endcode
  86
  87         \ingroup io_modules
  88      */
  89     template <class Writer=PacketWriter>
  90     class ActiveSocketWriter : public Module
  91     {
  92         SENF_PPI_MODULE(ActiveSocketWriter);
  93
  94     public:
  95         typedef typename Writer::Handle Handle; ///< Handle type requested by writer
  96
  97         connector::ActiveInput input; ///< Input connector from which data is received
  98
  99         ActiveSocketWriter(Handle handle); ///< Create new writer for the given handle
 100                                         /**< Data will be written to \a handle using \a Writer.
 101                                              \param[in] handle Handle to write data to */
 102     private:
 103         void write();
 104
 105         Handle handle_;
 106         IOEvent event_;
 107         Writer writer_;
 108     };
 109
 110     /** \brief Output module writing data to arbitrary FileHandle
 111
 112         This output module will write data to a FileHandle object using a given \a Writer. This
 113         output module is passive. This implies, that the output handle may not block. This also
 114         implies, that data will probably get lost if written to fast for the underlying transport
 115         mechanism. Either this is desired (like for a UDP socket) or some additional bandwidth
 116         shaping needs to be used.
 117
 118         The \a Writer must fulfill the following interface:
 119         \code
 120           class SomeWriter
 121           {
 122           public:
 123               typedef unspecified Handle;                          // type of handle requested
 124               SomeWriter();                                        // default constructible
 125               void operator()(Handle handle, Packet packet);       // insertion function
 126           };
 127         \endcode
 128
 129         \ingroup io_modules
 130      */
 131     template <class Writer=PacketWriter>
 132     class PassiveSocketWriter : public Module
 133     {
 134         SENF_PPI_MODULE(PassiveSocketWriter);
 135
 136     public:
 137         typedef typename Writer::Handle Handle; ///< Handle type requested by writer
 138
 139         connector::PassiveInput input; ///< Input connector from which data is received
 140
 141         PassiveSocketWriter(Handle handle); ///< Create new writer for the given handle
 142                                         /**< Data will be written to \a handle using \a Writer.
 143                                              \param[in] handle Handle to write data to */
 144
 145     private:
 146         void write();
 147
 148         Handle handle_;
 149         Writer writer_;
 150     };
 151
 152 }}}
 153
 154
 155 ///////////////////////////////hh.e////////////////////////////////////////
 156 #include "SocketWriter.cci"
 157 #include "SocketWriter.ct"
 158 //#include "SocketWriter.cti"
 159 #endif
 160
 161 \f
 162 // Local Variables:
 163 // mode: c++
 164 // fill-column: 100
 165 // c-file-style: "senf"
 166 // indent-tabs-mode: nil
 167 // ispell-local-dictionary: "american"
 168 // compile-command: "scons -u test"
 169 // comment-column: 40
 170 // End: