ndnph::BasicSegmentConsumer< SegmentConvention, regionCap > Class Template Reference

Consumer of segmented object, using a stop-and-wait algorithm. More...

#include <segment-consumer.hpp>

Inherits ndnph::SegmentConsumerBase.

Public Member Functions
	SegmentConsumerBase (Face &face, Options opts)
	Constructor. More...
	SegmentConsumerBase (Face &face)
Public Member Functions inherited from ndnph::SegmentConsumerBase
	SegmentConsumerBase (Face &face, Options opts)
	Constructor. More...
	SegmentConsumerBase (Face &face)
void	setSegmentCallback (SegmentCallback cb, void *ctx)
	Assign SegmentCallback. More...
void	saveTo (SaveDest &dest)
	Save content to destination. More...
void	start (Name prefix)
	Start fetching content under given prefix. More...
void	stop ()
	Stop fetching. More...
bool	isRunning () const
	Determine whether fetching is in progress (not completed or failed). More...
Public Member Functions inherited from ndnph::PacketHandler
	PacketHandler ()=default
	Construct without adding to Face. More...
	PacketHandler (Face &face, int8_t prio=0)
	Construct and add handler to Face. More...

Additional Inherited Members
Public Types inherited from ndnph::SegmentConsumerBase
using	SegmentCallback = void(*)(void *ctx, uint64_t segment, Data data)
	Callback upon segment arrival. More...
Public Types inherited from ndnph::PacketHandler
using	PacketInfo = Face::PacketInfo
Protected Member Functions inherited from ndnph::SegmentConsumerBase
void	invokeCallback (Data data)
Protected Member Functions inherited from ndnph::PacketHandler
virtual	~PacketHandler ()
	Remove handler from Face. More...
Face *	getFace () const
const PacketInfo *	getCurrentPacketInfo () const
	Retrieve information about current processing packet. More...
template<typename Packet >
bool	send (Region &region, const Packet &packet, PacketInfo pi={})
	Synchronously transmit a packet. More...
template<typename Packet , typename... PacketInfoModifier>
bool	send (Region &region, const Packet &packet, const PacketInfoModifier &... pim)
	Synchronously transmit a packet. More...
template<typename Packet , typename... Arg, typename = typename std::enable_if< !std::is_base_of<Region, typename std::decay<Packet>::type>::value>::type>
bool	send (const Packet &packet, Arg &&... arg)
	Synchronously transmit a packet. More...
template<typename... Arg>
bool	reply (Arg &&... arg)
	Synchronously transmit a packet in reply to current processing packet. More...
Protected Attributes inherited from ndnph::SegmentConsumerBase
Options	m_opts
SegmentCallback	m_cb = nullptr
void *	m_cbCtx = nullptr
Name	m_prefix
uint64_t	m_segment = 0
OutgoingPendingInterest	m_pending
int	m_retxRemain = 0
bool	m_running = false

Detailed Description

template<typename SegmentConvention = convention::Segment, size_t regionCap = 1024>
class ndnph::BasicSegmentConsumer< SegmentConvention, regionCap >

Consumer of segmented object, using a stop-and-wait algorithm.

Template Parameters

SegmentConvention	segment component convention.
regionCap	encoding region capacity.

Member Function Documentation

SegmentConsumerBase() [1/2]

template<typename SegmentConvention = convention::Segment, size_t regionCap = 1024>

ndnph::SegmentConsumerBase::SegmentConsumerBase

inlineexplicit

SegmentConsumerBase() [2/2]

template<typename SegmentConvention = convention::Segment, size_t regionCap = 1024>

ndnph::SegmentConsumerBase::SegmentConsumerBase

inlineexplicit

Constructor.

Parameters

face	face for communication.
opts	options.

---

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

• /home/runner/work/esp8266ndn/NDNph/src/ndnph/app/segment-consumer.hpp