ndnph::port_transport_memif::MemifTransport Class Reference

A transport that communicates via libmemif. More...

#include <memif.hpp>

Inherits ndnph::transport::Transport.

Classes
struct	Options

Public Types
enum class	Role { CLIENT = 0 , SERVER = 1 }
using	DefaultDataroom = std::integral_constant< uint16_t, 2048 >
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
bool	begin (const char *socketName, uint32_t id, uint16_t dataroom=0)
	Start transport.
bool	begin (Options opts)
	Start transport with advanced options.
bool	end ()
	Stop transport.
uint16_t	getDataroom () const
	Return actual dataroom.
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.

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

Additional Inherited Members
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.

Detailed Description

A transport that communicates via libmemif.

Current implementation only allows one memif transport per control socket name. It is compatible with NDN-DPDK dataplane, but has no management integration.

Member Typedef Documentation

DefaultDataroom

using ndnph::port_transport_memif::MemifTransport::DefaultDataroom = std::integral_constant<uint16_t, 2048>

Member Enumeration Documentation

Role

enum class ndnph::port_transport_memif::MemifTransport::Role

strong

Enumerator
CLIENT
SERVER

Member Function Documentation

begin() [1/2]

bool ndnph::port_transport_memif::MemifTransport::begin ( const char *  socketName, uint32_t  id, uint16_t  dataroom = 0  )

inline

Start transport.

Parameters

socketName	control socket name.
id	interface ID.
dataroom	maximum dataroom; 0 means library default.

begin() [2/2]

bool ndnph::port_transport_memif::MemifTransport::begin ( Options  opts )

inline

Start transport with advanced options.

doIsUp()

bool ndnph::port_transport_memif::MemifTransport::doIsUp ( ) const

inlinefinalprivatevirtual

Implements ndnph::transport::Transport.

doLoop()

void ndnph::port_transport_memif::MemifTransport::doLoop ( )

inlinefinalprivatevirtual

Implements ndnph::transport::Transport.

doSend()

bool ndnph::port_transport_memif::MemifTransport::doSend ( const uint8_t *  pkt, size_t  pktLen, uint64_t    )

inlinefinalprivatevirtual

Implements ndnph::transport::Transport.

end()

bool ndnph::port_transport_memif::MemifTransport::end ( )

inline

Stop transport.

getDataroom()

uint16_t ndnph::port_transport_memif::MemifTransport::getDataroom ( ) const

inline

Return actual dataroom.

---

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

• /home/runner/work/esp8266ndn/NDNph/src/ndnph/port/transport/memif.hpp