Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
// Stefan Bund <g0dil@berlios.de>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
/** \file
\brief SocketReader public header */
#ifndef HH_SocketReader_
#define HH_SocketReader_ 1
// Custom includes
#include "Packets/Packet.hh"
#include "Packets/DataPacket.hh"
#include "Module.hh"
#include "Connector.hh"
//#include "SocketReader.mpp"
///////////////////////////////hh.p////////////////////////////////////////
namespace senf {
namespace ppi {
/** \brief Read helper for module::ActiveSocketReader
This read helper will read a datagram from a datagram socket. This datagram will then be
interpreted as a packet of type \a Packet as defined in the packet library. \a Packet
defaults to \ref DataPacket, which will place the data uninterpreted into a packet data
structure.
*/
template <class Packet=DataPacket>
class PacketReader
{
public:
typedef senf::ClientSocketHandle<
senf::MakeSocketPolicy< senf::ReadablePolicy,
senf::DatagramFramingPolicy > > Handle;
///< Handle type supported by this reader
Packet::ptr operator()(Handle handle);
///< Read packet from \a handle
/**< Read a datagram from \a handle and interpret is as
packet of type \c Packet.
\param[in] handle Handle to read data from
\returns Pointer to new packet instance or 0, if no
packet could be read */
};
}}
namespace senf {
namespace ppi {
namespace module {
/** \brief Input module reading data from an arbitrary FileHandle
This input module will read data from a FileHandle object and parse the data according to
the \a Reader.
The \a Reader must fulfill the following interface:
\code
class SomeReader
{
public:
SomeReader(); // default constructible
Packet::ptr operator()(Handle handle); // extraction function
};
\endcode
*/
template <class Reader=PacketReader<> >
class ActiveSocketReader : public Module
{
public:
typedef typename Reader::Handle Handle; ///< Handle type requested by the reader
connector::ActiveOutput output; ///< Output connector to which the data received is written
ActiveSocketReader(Handle handle); ///< Create new reader for the given handle
/**< Data will be read from \a handle and be parsed by \a
Reader.
\param[in] handle Handle to read data from */
};
}}}
///////////////////////////////hh.e////////////////////////////////////////
//#include "SocketReader.cci"
//#include "SocketReader.ct"
//#include "SocketReader.cti"
#endif
// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"