senf::ppi::DgramReader< Packet, MaxSize > Class Template Reference

Reader for module::ActiveSocketSource. More...

#include <senf/PPI/SocketSource.hh>

Public Types
typedef Packet	PacketType
typedef senf::ClientSocketHandle< senf::MakeSocketPolicy< senf::ReadablePolicy, senf::DatagramFramingPolicy >::policy >	Handle
	Handle type supported by this reader. More...

Public Member Functions
Packet	operator() (Handle &handle)
	Read packet from handle. More...

Detailed Description

template<class Packet = DataPacket, unsigned MaxSize = 0u>
class senf::ppi::DgramReader< Packet, MaxSize >

Reader for module::ActiveSocketSource.

This read helper will read a datagram from a datagram socket. This datagram will then be interpreted as a packet of type Packet as defined in the packet library. Packet defaults to DataPacket (type DataPacketType), which will place the data uninterpreted into a packet data structure.

Definition at line 52 of file SocketSource.hh.

Member Typedef Documentation

Handle

template<class Packet = DataPacket, unsigned MaxSize = 0u>

typedef senf::ClientSocketHandle< senf::MakeSocketPolicy< senf::ReadablePolicy, senf::DatagramFramingPolicy >::policy > senf::ppi::DgramReader< Packet, MaxSize >::Handle

Handle type supported by this reader.

Definition at line 58 of file SocketSource.hh.

PacketType

template<class Packet = DataPacket, unsigned MaxSize = 0u>

typedef Packet senf::ppi::DgramReader< Packet, MaxSize >::PacketType

Definition at line 55 of file SocketSource.hh.

Member Function Documentation

operator()()

template<class Packet = DataPacket, unsigned MaxSize = 0u>

Packet senf::ppi::DgramReader< Packet, MaxSize >::operator()

(

Handle &

handle

)

Read packet from handle.

Read a datagram from handle and interpret is as packet of type Packet.

Parameters

[in]

handle

Handle to read data from

Returns

Pointer to new packet instance or 0, if no packet could be read

---

The documentation for this class was generated from the following file:

• SocketSource.hh