ndnph::transport::RxQueueMixin Class Reference

Mixin of RX queue in Transport. More...

#include <transport-rxqueue.hpp>

Inherits ndnph::transport::Transport.

Inherited by ndnph::transport::DynamicRxQueueMixin.

Classes
class	RxContext

Protected Member Functions
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.
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.

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)
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.

Detailed Description

Mixin of RX queue in Transport.

Member Function Documentation

initAllocBuffers()

template<typename F >

void ndnph::transport::RxQueueMixin::initAllocBuffers ( const F &  makeRegion )

inlineprotected

Allocate receive buffers during initialization.

Template Parameters

F	`Region* (*)()`

loopRxQueue()

void ndnph::transport::RxQueueMixin::loopRxQueue ( )

inlineprotected

Process periodical events.

This delivers received packets to Face. This should be called in `loop()`.

receiving()

RxContext ndnph::transport::RxQueueMixin::receiving ( )

inlineprotected

Receive packets in a loop.

while (auto r = receiving()) {
  if (receiveInto(r.buf(), r.bufLen())) {
    r(pktLen);
  } else {
    break;
  }
}

---

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

• /home/runner/work/esp8266ndn/NDNph/src/ndnph/face/transport-rxqueue.hpp