Producer of RDR metadata packet. More...

#include <rdr.hpp>

Classes
struct	Options

Public Member Functions
	RdrMetadataProducer (const Name &rdrPrefix, Face &face, const Options &opts)
	Constructor.

	RdrMetadataProducer (const Name &rdrPrefix, Face &face)

void	setDatasetPrefix (Name datasetPrefix)
	Set the dataset prefix.

Public Member Functions inherited from ndnph::PacketHandler
	PacketHandler ()=default
	Construct without adding to Face.

	PacketHandler (Face &face, int8_t prio=0)
	Construct and add handler to Face.

Private Member Functions
bool	processInterest (Interest interest) final
	Override to receive Interest packets.

virtual void	prepareRdrContent (Encoder &encoder, const Name &datasetPrefix)
	Prepare Content of RDR metadata packet.

Additional Inherited Members
Public Types inherited from ndnph::PacketHandler
using	PacketInfo = Face::PacketInfo

Protected Member Functions inherited from ndnph::PacketHandler
virtual	~PacketHandler ()
	Remove handler from Face.

Face *	getFace () const

const PacketInfo *	getCurrentPacketInfo () const
	Retrieve information about current processing packet.

template<typename Packet >
bool	send (Region &region, const Packet &packet, PacketInfo pi={})
	Synchronously transmit a packet.

template<typename Packet , typename... PacketInfoModifier>
bool	send (Region &region, const Packet &packet, const PacketInfoModifier &... pim)
	Synchronously transmit a packet.

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.

template<typename... Arg>
bool	reply (Arg &&... arg)
	Synchronously transmit a packet in reply to current processing packet.

Detailed Description

Producer of RDR metadata packet.

See also: https://redmine.named-data.net/projects/ndn-tlv/wiki/RDR

This is typically used together with SegmentProducer to serve a versioned dataset. When a new version becomes available, application shall invoke SegmentProducer::setContent and RdrMetadataProducer::setDatasetPrefix with the same prefix.

Constructor & Destructor Documentation

◆ RdrMetadataProducer() [1/2]

ndnph::rdr::RdrMetadataProducer::RdrMetadataProducer	(	const Name &	rdrPrefix,
		Face &	face,
		const Options &	opts
	)

inlineexplicit

Constructor.

Parameters

rdrPrefix	prefix of metadata packets; must be kept alive until producer is destructed.
face	face for communication.
opts	options.

◆ RdrMetadataProducer() [2/2]

ndnph::rdr::RdrMetadataProducer::RdrMetadataProducer	(	const Name &	rdrPrefix,
		Face &	face
	)

inlineexplicit

Member Function Documentation

◆ prepareRdrContent()

virtual void ndnph::rdr::RdrMetadataProducer::prepareRdrContent	(	Encoder &	encoder,
		const Name &	datasetPrefix
	)

inlineprivatevirtual

Prepare Content of RDR metadata packet.

Subclass can override this method to add extensions in the Content.

◆ processInterest()

bool ndnph::rdr::RdrMetadataProducer::processInterest ( Interest )

inlinefinalprivatevirtual

Override to receive Interest packets.

Return values

true	packet has been accepted by this handler.
false	packet is not accepted, and should go to the next handler.

Reimplemented from ndnph::PacketHandler.

◆ setDatasetPrefix()

void ndnph::rdr::RdrMetadataProducer::setDatasetPrefix ( Name datasetPrefix )

inline

Set the dataset prefix.

Parameters

datasetPrefix the dataset prefix to appear in RDR metadata packet.

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

/home/runner/work/esp8266ndn/NDNph/src/ndnph/app/rdr.hpp

Classes

Public Member Functions

Private Member Functions

Additional Inherited Members