Periodically transmit Interests to test reachability. More...

#include <ping-client.hpp>

Classes
struct	Counters

Public Member Functions
	PingClient (Name prefix, Face &face, int interval=1000)
	Constructor.

Counters	readCounters () const

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
void	loop () final
	Override to be invoked periodically.

bool	processData (Data data) final
	Override to receive Data packets.

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

Periodically transmit Interests to test reachability.

This is a simple ping client implementation that can only keep one pending Interest. After sending a probe Interest, responses to previous Interests are no longer accepted. Therefore, interval must be greater than RTT, otherwise this client cannot receive any Data.

Constructor & Destructor Documentation

◆ PingClient()

ndnph::PingClient::PingClient	(	Name	prefix,
		Face &	face,
		int	interval = `1000`
	)

inlineexplicit

Constructor.

Parameters

prefix	name prefix to request. It should have 'ping' suffix.
face	face for communication.
interval	Interest interval in milliseconds.

Member Function Documentation

◆ loop()

void ndnph::PingClient::loop ( )

inlinefinalprivatevirtual

Override to be invoked periodically.

Reimplemented from ndnph::PacketHandler.

◆ processData()

bool ndnph::PingClient::processData ( Data )

inlinefinalprivatevirtual

Override to receive Data 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.

◆ readCounters()

Counters ndnph::PingClient::readCounters ( ) const

inline

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

/home/runner/work/esp8266ndn/NDNph/src/ndnph/app/ping-client.hpp

Classes

Public Member Functions

Private Member Functions