4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief SocketSource public header */
26 #ifndef HH_SENF_PPI_SocketSource_
27 #define HH_SENF_PPI_SocketSource_ 1
30 #include <senf/Packets/Packets.hh>
31 #include <senf/Socket/ClientSocketHandle.hh>
32 #include <senf/Socket/SocketPolicy.hh>
33 #include <senf/Socket/ReadWritePolicy.hh>
34 #include <senf/Socket/FramingPolicy.hh>
36 #include "Connectors.hh"
39 //#include "SocketSource.mpp"
40 ///////////////////////////////hh.p////////////////////////////////////////
45 /** \brief Reader for module::ActiveSocketSource
47 This read helper will read a datagram from a datagram socket. This datagram will then be
48 interpreted as a packet of type \a Packet as defined in the packet library. \a Packet
49 defaults to DataPacket (type DataPacketType), which will place the data uninterpreted
50 into a packet data structure.
52 template <class Packet=DataPacket, unsigned MaxSize=0u>
56 typedef Packet PacketType;
57 typedef senf::ClientSocketHandle<
58 senf::MakeSocketPolicy< senf::ReadablePolicy,
59 senf::DatagramFramingPolicy >::policy > Handle;
60 ///< Handle type supported by this reader
62 Packet operator()(Handle & handle);
63 ///< Read packet from \a handle
64 /**< Read a datagram from \a handle and interpret is as
65 packet of type \c Packet.
66 \param[in] handle Handle to read data from
67 \returns Pointer to new packet instance or 0, if no
68 packet could be read */
77 /** \brief Input module reading data from an arbitrary FileHandle
79 This input module will read data from a FileHandle object and parse the data according to
80 the \a Reader. The default reader is senf::ppi::DgramReader <> which reads the data into a
81 senf::DataPacket. To parse the data according to some other packet type, pass that packet
82 type to senf::ppi::DgramReader:
84 senf::ppi::module::ActiveSocketSource< senf::ppi::DgramReader<senf::EthernetPacket> > source;
86 declares a \a reader module reading senf::EthernetPacket's
88 A \a Reader must fulfill the following interface:
93 typedef unspecified_type Handle; // type of handle requested
94 typedef unspecified_type PacketType // type of packet returned
96 SomeReader(); // EITHER default constructible
97 SomeReader(SomeReader const & other); // OR copy constructible
99 PacketType operator()(Handle handle); // extraction function
102 Whenever the FileHandle object is ready for reading, the \a Reader's \c operator() is called
107 template <class Reader=DgramReader<> >
108 class ActiveSocketSource
111 SENF_PPI_MODULE(ActiveSocketSource);
114 typedef typename Reader::Handle Handle; ///< Handle type requested by the reader
116 connector::ActiveOutput<typename Reader::PacketType> output;
117 ///< Output connector to which the data received is written
119 ActiveSocketSource(); ///< Create non-connected reader
120 /**< The reader will be disabled until a socket is set
121 \pre Requires \a Reader to be default constructible */
122 explicit ActiveSocketSource(Reader reader); ///< Create non-connected reader
123 /**< The reader will be disabled until a socket is set
124 \pre Requires \a Reader to be copy constructible */
125 explicit ActiveSocketSource(Handle const & handle);
126 ///< Create new reader for the given handle
127 /**< Data will be read from \a handle and be parsed by \a
129 \pre Requires \a Reader to be default constructible
130 \param[in] handle Handle to read data from */
131 ActiveSocketSource(Handle const & handle, Reader reader);
132 ///< Create new reader for the given handle
133 /**< Data will be read from \a handle and be parsed by \a
135 \pre Requires \a Reader to be copy constructible
136 \param[in] handle Handle to read data from */
138 Reader & reader(); ///< Access Reader helper
139 Handle handle(); ///< Access handle
140 void handle(Handle const & handle);
142 /**< Assigning an empty or in-valid() handle will disable
143 the module until a new, valid handle is assigned. */
153 template <class Reader=DgramReader<> >
154 class ActiveBurstSocketSource
157 SENF_PPI_MODULE(ActiveBurstSocketSource);
160 typedef typename Reader::Handle Handle; ///< Handle type requested by the reader
162 connector::ActiveOutput<typename Reader::PacketType> output;
163 ///< Output connector to which the data received is written
165 ActiveBurstSocketSource(unsigned max_burst);
166 explicit ActiveBurstSocketSource(Reader reader, unsigned max_burst);
167 explicit ActiveBurstSocketSource(Handle const & handle, unsigned max_burst);
168 ActiveBurstSocketSource(Handle const & handle, Reader reader, unsigned max_burst);
170 Reader & reader(); ///< Access Reader helper
171 Handle handle(); ///< Access handle
172 void handle(Handle const & handle);
174 /**< Assigning an empty or in-valid() handle will disable
175 the module until a new, valid handle is assigned. */
177 unsigned maxBurst() const;
178 void maxBurst(unsigned max_burst);
191 ///////////////////////////////hh.e////////////////////////////////////////
192 //#include "SocketSource.cci"
193 #include "SocketSource.ct"
194 #include "SocketSource.cti"
201 // c-file-style: "senf"
202 // indent-tabs-mode: nil
203 // ispell-local-dictionary: "american"
204 // compile-command: "scons -u test"
205 // comment-column: 40