ndn::nfd Namespace Reference

Data Structures
class	ChannelDataset
	represents a faces/channels dataset More...
class	ChannelStatus
	represents NFD Channel Status dataset More...
class	CommandOptions
	contains options for ControlCommand execution More...
class	ControlCommand
	base class of NFD ControlCommand More...
class	Controller
	NFD Management protocol client. More...
class	ControlParameters
	represents parameters in a ControlCommand request or response More...
class	FaceCreateCommand
	represents a faces/create command More...
class	FaceDataset
	represents a faces/list dataset More...
class	FaceDatasetBase
	provides common functionality among FaceDataset and FaceQueryDataset More...
class	FaceDestroyCommand
	represents a faces/destroy command More...
class	FaceDisableLocalControlCommand
	represents a faces/disable-local-control command More...
class	FaceEnableLocalControlCommand
	represents a faces/enable-local-control command More...
class	FaceEventNotification
	represents a Face status change notification More...
class	FaceLocalControlCommand
	Base class for faces/[*]-local-control commands. More...
class	FaceMonitor
	A subscriber for Face status change notification stream. More...
class	FaceQueryDataset
	represents a faces/query dataset More...
class	FaceQueryFilter
	represents Face Query Filter More...
class	FaceStatus
	represents Face status More...
class	FaceTraits
	providers getters and setters of face information fields More...
class	FaceUpdateCommand
	represents a faces/update command More...
class	FibAddNextHopCommand
	represents a fib/add-nexthop command More...
class	FibDataset
	represents a fib/list dataset More...
class	FibEntry
class	FibRemoveNextHopCommand
	represents a fib/remove-nexthop command More...
class	ForwarderGeneralStatusDataset
	represents a status/general dataset More...
class	ForwarderStatus
	represents NFD Forwarder Status More...
class	NextHopRecord
class	RibDataset
	represents a rib/list dataset More...
class	RibEntry
	Data abstraction for RIB entry. More...
class	RibFlagsTraits
	implements getters to each RIB flag More...
class	RibRegisterCommand
	represents a rib/register command More...
class	RibUnregisterCommand
	represents a rib/unregister command More...
class	Route
	Data abstraction for Route. More...
class	StatusDataset
	base class of NFD StatusDataset More...
class	StrategyChoice
	represents NFD StrategyChoice dataset More...
class	StrategyChoiceDataset
	represents a strategy-choice/list dataset More...
class	StrategyChoiceSetCommand
	represents a strategy-choice/set command More...
class	StrategyChoiceUnsetCommand
	represents a strategy-choice/set command More...

Typedefs
typedef ndn::mgmt::ControlResponse	ControlResponse

Enumerations
enum	FaceScope : uint8_t { FACE_SCOPE_NONE = std::numeric_limits<uint8_t>::max(), FACE_SCOPE_NON_LOCAL = 0, FACE_SCOPE_LOCAL = 1 }
enum	FacePersistency : uint8_t { FACE_PERSISTENCY_NONE = std::numeric_limits<uint8_t>::max(), FACE_PERSISTENCY_PERSISTENT = 0, FACE_PERSISTENCY_ON_DEMAND = 1, FACE_PERSISTENCY_PERMANENT = 2 }
enum	FaceFlagBit { BIT_LOCAL_FIELDS_ENABLED = 0 }
enum	LinkType : uint8_t { LINK_TYPE_NONE = std::numeric_limits<uint8_t>::max(), LINK_TYPE_POINT_TO_POINT = 0, LINK_TYPE_MULTI_ACCESS = 1 }
enum	RouteOrigin : uint16_t {   ROUTE_ORIGIN_NONE = std::numeric_limits<uint16_t>::max(), ROUTE_ORIGIN_APP = 0, ROUTE_ORIGIN_AUTOREG = 64, ROUTE_ORIGIN_CLIENT = 65,   ROUTE_ORIGIN_AUTOCONF = 66, ROUTE_ORIGIN_NLSR = 128, ROUTE_ORIGIN_STATIC = 255 }
enum	RouteFlags { ROUTE_FLAGS_NONE = 0, ROUTE_FLAG_CHILD_INHERIT = 1, ROUTE_FLAG_CAPTURE = 2 }
enum	ControlParameterField {   CONTROL_PARAMETER_NAME, CONTROL_PARAMETER_FACE_ID, CONTROL_PARAMETER_URI, CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE,   CONTROL_PARAMETER_ORIGIN, CONTROL_PARAMETER_COST, CONTROL_PARAMETER_FLAGS, CONTROL_PARAMETER_MASK,   CONTROL_PARAMETER_STRATEGY, CONTROL_PARAMETER_EXPIRATION_PERIOD, CONTROL_PARAMETER_FACE_PERSISTENCY, CONTROL_PARAMETER_UBOUND }
enum	LocalControlFeature { LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID = 1, LOCAL_CONTROL_FEATURE_NEXT_HOP_FACE_ID = 2 }
enum	FaceEventKind { FACE_EVENT_CREATED = 1, FACE_EVENT_DESTROYED = 2, FACE_EVENT_UP = 3, FACE_EVENT_DOWN = 4 }

Functions
std::ostream &	operator<< (std::ostream &os, FaceScope faceScope)
std::ostream &	operator<< (std::ostream &os, FacePersistency facePersistency)
std::ostream &	operator<< (std::ostream &os, LinkType linkType)
std::ostream &	operator<< (std::ostream &os, RouteOrigin routeOrigin)
std::ostream &	operator<< (std::ostream &os, RouteFlags routeFlags)
template size_t	ChannelStatus::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	ChannelStatus::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
template size_t	ControlParameters::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	ControlParameters::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
std::ostream &	operator<< (std::ostream &os, const ControlParameters &parameters)
std::ostream &	operator<< (std::ostream &os, const FaceEventNotification &notification)
template size_t	FaceQueryFilter::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	FaceQueryFilter::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
std::ostream &	operator<< (std::ostream &os, const FaceQueryFilter &filter)
template size_t	FaceStatus::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &block) const
template size_t	FaceStatus::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &block) const
std::ostream &	operator<< (std::ostream &os, const FaceStatus &status)
template size_t	NextHopRecord::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &block) const
template size_t	NextHopRecord::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &block) const
template size_t	FibEntry::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &block) const
template size_t	FibEntry::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &block) const
template size_t	ForwarderStatus::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	ForwarderStatus::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
template size_t	Route::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &block) const
template size_t	Route::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &block) const
std::ostream &	operator<< (std::ostream &os, const Route &route)
template size_t	RibEntry::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &block) const
template size_t	RibEntry::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &block) const
std::ostream &	operator<< (std::ostream &os, const RibEntry &entry)
template<typename T >
static std::vector< T >	parseDatasetVector (ConstBufferPtr payload)
	parses elements into a vector of T More...
template size_t	StrategyChoice::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	StrategyChoice::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
bool	operator== (const StrategyChoice &a, const StrategyChoice &b)
std::ostream &	operator<< (std::ostream &os, const StrategyChoice &sc)
bool	operator!= (const StrategyChoice &a, const StrategyChoice &b)

Variables
static const uint64_t	INVALID_FACE_ID = std::numeric_limits<uint64_t>::max()
	WireEncodable< ChannelStatus >
	WireDecodable< ChannelStatus >
	WireEncodable< ControlParameters >
	WireDecodable< ControlParameters >
const std::string	CONTROL_PARAMETER_FIELD [CONTROL_PARAMETER_UBOUND]
	WireEncodable< FaceEventNotification >
	WireDecodable< FaceEventNotification >
	WireEncodable< FaceQueryFilter >
	WireDecodable< FaceQueryFilter >
	WireEncodable< FaceStatus >
	WireDecodable< FaceStatus >
	WireEncodable< NextHopRecord >
	WireDecodable< NextHopRecord >
	WireEncodable< FibEntry >
	WireDecodable< FibEntry >
	WireEncodable< ForwarderStatus >
	WireDecodable< ForwarderStatus >
	WireEncodable< Route >
	WireDecodable< Route >
	WireEncodable< RibEntry >
	WireDecodable< RibEntry >
	WireEncodable< StrategyChoice >
	WireEncodableWithEncodingBuffer< StrategyChoice >
	WireDecodable< StrategyChoice >

Typedef Documentation

typedef ndn::mgmt::ControlResponse ndn::nfd::ControlResponse

Definition at line 30 of file nfd/control-response.hpp.

Function Documentation

template size_t ndn::nfd::ChannelStatus::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

)

const

template size_t ndn::nfd::ChannelStatus::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

)

const

template size_t ndn::nfd::ControlParameters::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

)

const

template size_t ndn::nfd::ControlParameters::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

)

const

template size_t ndn::nfd::FaceQueryFilter::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

)

const

template size_t ndn::nfd::FaceQueryFilter::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

)

const

template size_t ndn::nfd::FaceStatus::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

template size_t ndn::nfd::FaceStatus::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

template size_t ndn::nfd::FibEntry::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

template size_t ndn::nfd::FibEntry::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

template size_t ndn::nfd::ForwarderStatus::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

)

const

template size_t ndn::nfd::ForwarderStatus::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

)

const

template size_t ndn::nfd::NextHopRecord::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

template size_t ndn::nfd::NextHopRecord::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

bool ndn::nfd::operator!= ( const StrategyChoice &  a, const StrategyChoice &  b  )

inline

Definition at line 94 of file strategy-choice.hpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		FaceScope	faceScope
	)

Definition at line 30 of file nfd-constants.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		FacePersistency	facePersistency
	)

Definition at line 45 of file nfd-constants.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		LinkType	linkType
	)

Definition at line 62 of file nfd-constants.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		RouteOrigin	routeOrigin
	)

Definition at line 77 of file nfd-constants.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		RouteFlags	routeFlags
	)

Definition at line 100 of file nfd-constants.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const StrategyChoice &	sc
	)

Definition at line 136 of file strategy-choice.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const FaceEventNotification &	notification
	)

Definition at line 179 of file face-event-notification.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const Route &	route
	)

Definition at line 183 of file rib-entry.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const ControlParameters &	parameters
	)

Definition at line 278 of file control-parameters.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const RibEntry &	entry
	)

Definition at line 305 of file rib-entry.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const FaceQueryFilter &	filter
	)

Definition at line 317 of file face-query-filter.cpp.

std::ostream & ndn::nfd::operator<<	(	std::ostream &	os,
		const FaceStatus &	status
	)

Definition at line 343 of file face-status.cpp.

bool ndn::nfd::operator==	(	const StrategyChoice &	a,
		const StrategyChoice &	b
	)

Definition at line 130 of file strategy-choice.cpp.

template<typename T >

static std::vector<T> ndn::nfd::parseDatasetVector ( ConstBufferPtr  payload )

static

parses elements into a vector of T

Template Parameters

T	element type

Parameters

payload

pointer to a buffer of zero or more blocks of decodable by T

Returns

a vector of T

Exceptions

tlv::Error

cannot parse payload

Definition at line 58 of file status-dataset.cpp.

template size_t ndn::nfd::RibEntry::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

template size_t ndn::nfd::RibEntry::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

template size_t ndn::nfd::Route::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

template size_t ndn::nfd::Route::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

template size_t ndn::nfd::StrategyChoice::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

)

const

template size_t ndn::nfd::StrategyChoice::wireEncode< encoding::EstimatorTag >

(

EncodingImpl< encoding::EstimatorTag > &

)

const

Variable Documentation

const std::string ndn::nfd::CONTROL_PARAMETER_FIELD[CONTROL_PARAMETER_UBOUND]

Initial value:

= {
  "Name",
  "FaceId",
  "Uri",
  "LocalControlFeature",
  "Origin",
  "Cost",
  "Flags",
  "Mask",
  "Strategy",
  "ExpirationPeriod",
  "FacePersistency"
}

Definition at line 51 of file nfd/control-parameters.hpp.

const uint64_t ndn::nfd::INVALID_FACE_ID = std::numeric_limits<uint64_t>::max()

static

Definition at line 30 of file nfd-constants.hpp.

ndn::nfd::WireDecodable< ChannelStatus >

Definition at line 32 of file channel-status.cpp.

ndn::nfd::WireDecodable< ControlParameters >

Definition at line 32 of file control-parameters.cpp.

ndn::nfd::WireDecodable< FaceEventNotification >

Definition at line 32 of file face-event-notification.cpp.

ndn::nfd::WireDecodable< FaceQueryFilter >

Definition at line 32 of file face-query-filter.cpp.

ndn::nfd::WireDecodable< FaceStatus >

Definition at line 32 of file face-status.cpp.

ndn::nfd::WireDecodable< FibEntry >

Definition at line 39 of file fib-entry.cpp.

ndn::nfd::WireDecodable< ForwarderStatus >

Definition at line 32 of file forwarder-status.cpp.

ndn::nfd::WireDecodable< NextHopRecord >

Definition at line 33 of file fib-entry.cpp.

ndn::nfd::WireDecodable< RibEntry >

Definition at line 38 of file rib-entry.cpp.

ndn::nfd::WireDecodable< Route >

Definition at line 32 of file rib-entry.cpp.

ndn::nfd::WireDecodable< StrategyChoice >

Definition at line 33 of file strategy-choice.cpp.

ndn::nfd::WireEncodable< ChannelStatus >

Definition at line 31 of file channel-status.cpp.

ndn::nfd::WireEncodable< ControlParameters >

Definition at line 31 of file control-parameters.cpp.

ndn::nfd::WireEncodable< FaceEventNotification >

Definition at line 31 of file face-event-notification.cpp.

ndn::nfd::WireEncodable< FaceQueryFilter >

Definition at line 31 of file face-query-filter.cpp.

ndn::nfd::WireEncodable< FaceStatus >

Definition at line 31 of file face-status.cpp.

ndn::nfd::WireEncodable< FibEntry >

Definition at line 35 of file fib-entry.cpp.

ndn::nfd::WireEncodable< ForwarderStatus >

Definition at line 31 of file forwarder-status.cpp.

ndn::nfd::WireEncodable< NextHopRecord >

Definition at line 32 of file fib-entry.cpp.

ndn::nfd::WireEncodable< RibEntry >

Definition at line 34 of file rib-entry.cpp.

ndn::nfd::WireEncodable< Route >

Definition at line 31 of file rib-entry.cpp.

ndn::nfd::WireEncodable< StrategyChoice >

Definition at line 31 of file strategy-choice.cpp.

ndn::nfd::WireEncodableWithEncodingBuffer< StrategyChoice >

Definition at line 32 of file strategy-choice.cpp.