2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
3 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
4 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
22 \brief SocketWriter public header */
24 #ifndef HH_SocketWriter_
25 #define HH_SocketWriter_ 1
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"
35 #include "Connectors.hh"
37 //#include "SocketWriter.mpp"
38 ///////////////////////////////hh.p////////////////////////////////////////
43 /** \brief Write helper for module::ActiveSocketWriter / module::PassiveSocketWriter
45 This write helper will write the packets completely as datagrams to the given socket.
50 typedef senf::ClientSocketHandle<
51 senf::MakeSocketPolicy< senf::WriteablePolicy,
52 senf::DatagramFramingPolicy,
53 senf::ConnectedCommunicationPolicy>::policy > Handle;
54 ///< Handle type supported by this writer
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
60 \param[in] handle Handle to write data to
61 \param[in] packet Packet to write */
70 /** \brief Output module writing data to arbitrary FileHandle
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.
76 The \a Writer must fulfill the following interface:
81 typedef unspecified Handle; // type of handle requested
82 SomeWriter(); // default constructible
83 void operator()(Handle handle, Packet packet); // insertion function
89 template <class Writer=PacketWriter>
90 class ActiveSocketWriter : public Module
92 SENF_PPI_MODULE(ActiveSocketWriter);
95 typedef typename Writer::Handle Handle; ///< Handle type requested by writer
97 connector::ActiveInput input; ///< Input connector from which data is received
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 */
110 /** \brief Output module writing data to arbitrary FileHandle
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.
118 The \a Writer must fulfill the following interface:
123 typedef unspecified Handle; // type of handle requested
124 SomeWriter(); // default constructible
125 void operator()(Handle handle, Packet packet); // insertion function
131 template <class Writer=PacketWriter>
132 class PassiveSocketWriter : public Module
134 SENF_PPI_MODULE(PassiveSocketWriter);
137 typedef typename Writer::Handle Handle; ///< Handle type requested by writer
139 connector::PassiveInput input; ///< Input connector from which data is received
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 */
155 ///////////////////////////////hh.e////////////////////////////////////////
156 #include "SocketWriter.cci"
157 #include "SocketWriter.ct"
158 //#include "SocketWriter.cti"
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