nfd::face::EthernetChannel Class Reference

Class implementing Ethernet-based channel to create faces. More...

#include <daemon/face/ethernet-channel.hpp>

Inheritance diagram for nfd::face::EthernetChannel:

Collaboration diagram for nfd::face::EthernetChannel:

Classes
class	Error
	EthernetChannel-related error. More...

Public Member Functions
	EthernetChannel (shared_ptr< const ndn::net::NetworkInterface > localEndpoint, time::nanoseconds idleTimeout)
	Create an Ethernet channel on the given localEndpoint (network interface) More...
void	connect (const ethernet::Address &remoteEndpoint, ndn::nfd::FacePersistency persistency, bool wantLpReliability, const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onConnectFailed)
	Create a unicast Ethernet face toward remoteEndpoint. More...
const FaceUri &	getUri () const
bool	isListening () const override
	Returns whether the channel is listening. More...
void	listen (const FaceCreatedCallback &onFaceCreated, const FaceCreationFailedCallback &onFaceCreationFailed)
	Start listening. More...
size_t	size () const override
	Returns the number of faces in the channel. More...

Protected Member Functions
void	setUri (const FaceUri &uri)

Detailed Description

Class implementing Ethernet-based channel to create faces.

Definition at line 40 of file ethernet-channel.hpp.

Constructor & Destructor Documentation

nfd::face::EthernetChannel::EthernetChannel	(	shared_ptr< const ndn::net::NetworkInterface >	localEndpoint,
		time::nanoseconds	idleTimeout
	)

Create an Ethernet channel on the given localEndpoint (network interface)

To enable creation of faces upon incoming connections, one needs to explicitly call EthernetChannel::listen method.

Definition at line 40 of file ethernet-channel.cpp.

Member Function Documentation

void nfd::face::EthernetChannel::connect	(	const ethernet::Address &	remoteEndpoint,
		ndn::nfd::FacePersistency	persistency,
		bool	wantLpReliability,
		const FaceCreatedCallback &	onFaceCreated,
		const FaceCreationFailedCallback &	onConnectFailed
	)

Create a unicast Ethernet face toward remoteEndpoint.

Parameters

remoteEndpoint	The remote Ethernet endpoint
persistency	Persistency of the newly created face
wantLpReliability	whether LpReliability should be enabled
onFaceCreated	Callback to notify successful creation of the face
onConnectFailed	Callback to notify errors

Definition at line 56 of file ethernet-channel.cpp.

const FaceUri& nfd::face::Channel::getUri ( ) const

inlineinherited

Definition at line 59 of file channel.hpp.

bool nfd::face::EthernetChannel::isListening ( ) const

inlineoverridevirtual

Returns whether the channel is listening.

Implements nfd::face::Channel.

Definition at line 66 of file ethernet-channel.hpp.

void nfd::face::EthernetChannel::listen	(	const FaceCreatedCallback &	onFaceCreated,
		const FaceCreationFailedCallback &	onFaceCreationFailed
	)

Start listening.

Enable listening on the local endpoint, waiting for incoming frames, and creating a face when a frame is received from a new remote host.

Faces created in this way will have on-demand persistency.

Parameters

onFaceCreated	Callback to notify successful creation of a face
onFaceCreationFailed	Callback to notify errors

Exceptions

Error

Definition at line 79 of file ethernet-channel.cpp.

void nfd::face::Channel::setUri ( const FaceUri &  uri )

protectedinherited

Definition at line 34 of file channel.cpp.

size_t nfd::face::EthernetChannel::size ( ) const

inlineoverridevirtual

Returns the number of faces in the channel.

Implements nfd::face::Channel.

Definition at line 72 of file ethernet-channel.hpp.