esp8266ndn::EthernetTransport Class Reference

A transport that communicates over Ethernet. More...

#include <ethernet-transport.hpp>

Inherits ndnph::transport::Transport, and ndnph::transport::DynamicRxQueueMixin.

Public Member Functions
	EthernetTransport ()
	~EthernetTransport () override
bool	begin (const char ifname[2], uint8_t ifnum)
	Start intercepting NDN packets on a network interface.
bool	begin ()
	Start intercepting NDN packets on first available station interface.
void	end ()
	Disable the transport.
Public Member Functions inherited from ndnph::transport::Transport
virtual	~Transport ()=default
bool	isUp () const
	Determine whether transport is connected.
void	loop ()
	Process periodical events, such as receiving packets.
void	setRxCallback (RxCallback cb, void *ctx)
	Set incoming packet callback.
bool	send (const uint8_t *pkt, size_t pktLen, uint64_t endpointId=0)
	Synchronously transmit a packet.

Static Public Member Functions
static void	listNetifs (Print &os)
	Print a list of network interfaces.

Private Member Functions
bool	doIsUp () const final
void	doLoop () final
bool	doSend (const uint8_t *pkt, size_t pktLen, uint64_t endpointId) final

Additional Inherited Members
Public Types inherited from ndnph::transport::Transport
using	RxCallback = void(*)(void *ctx, const uint8_t *pkt, size_t pktLen, uint64_t endpointId)
Static Public Attributes inherited from ndnph::transport::DynamicRxQueueMixin
static constexpr size_t	DEFAULT_BUFLEN = 1500
Protected Member Functions inherited from ndnph::transport::Transport
void	invokeRxCallback (const uint8_t *pkt, size_t pktLen, uint64_t endpointId=0)
	Invoke incoming packet callback for a received packet.
Protected Member Functions inherited from ndnph::transport::DynamicRxQueueMixin
	DynamicRxQueueMixin (size_t bufLen=DEFAULT_BUFLEN)
	Constructor.
Protected Member Functions inherited from ndnph::transport::RxQueueMixin
template<typename F >
void	initAllocBuffers (const F &makeRegion)
	Allocate receive buffers during initialization.
RxContext	receiving ()
	Receive packets in a loop.
void	loopRxQueue ()
	Process periodical events.

Detailed Description

A transport that communicates over Ethernet.

Constructor & Destructor Documentation

EthernetTransport()

esp8266ndn::EthernetTransport::EthernetTransport

(

)

~EthernetTransport()

esp8266ndn::EthernetTransport::~EthernetTransport ( )

override

Member Function Documentation

begin() [1/2]

bool esp8266ndn::EthernetTransport::begin

(

)

Start intercepting NDN packets on first available station interface.

Returns

whether success.

begin() [2/2]

bool esp8266ndn::EthernetTransport::begin	(	const char	ifname[2],
		uint8_t	ifnum
	)

Start intercepting NDN packets on a network interface.

Returns

whether success.

doIsUp()

bool esp8266ndn::EthernetTransport::doIsUp ( ) const

finalprivatevirtual

Implements ndnph::transport::Transport.

doLoop()

void esp8266ndn::EthernetTransport::doLoop ( )

finalprivatevirtual

Implements ndnph::transport::Transport.

doSend()

bool esp8266ndn::EthernetTransport::doSend ( const uint8_t *  pkt, size_t  pktLen, uint64_t  endpointId  )

finalprivatevirtual

Implements ndnph::transport::Transport.

end()

void esp8266ndn::EthernetTransport::end

(

)

Disable the transport.

listNetifs()

static void esp8266ndn::EthernetTransport::listNetifs ( Print &  os )

static

Print a list of network interfaces.

---

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

• /home/runner/work/esp8266ndn/esp8266ndn/src/transport/ethernet-transport.hpp