ndn::nfd Namespace Reference

Classes
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 - ControlCommand client. More...
class	ControlParameters
	represents parameters in a ControlCommand request or response More...
class	FaceCreateCommand
	represents a faces/create command 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	FaceQueryFilter
	represents Face Query Filter More...
class	FaceStatus
	represents Face status More...
class	FaceTraits
	providers getters and setters of face information fields More...
class	FibAddNextHopCommand
	represents a fib/add-nexthop command More...
class	FibEntry
class	FibRemoveNextHopCommand
	represents a fib/remove-nexthop command More...
class	ForwarderStatus
	represents NFD Forwarder Status More...
class	LocalControlHeader
	Class to handle work with LocalControlHeader. More...
class	NextHopRecord
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	StrategyChoice
	represents NFD StrategyChoice 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 { FACE_SCOPE_NON_LOCAL = 0, FACE_SCOPE_LOCAL = 1 }
enum	FacePersistency { FACE_PERSISTENCY_PERSISTENT = 0, FACE_PERSISTENCY_ON_DEMAND = 1, FACE_PERSISTENCY_PERMANENT = 2 }
enum	LinkType { LINK_TYPE_POINT_TO_POINT = 0, LINK_TYPE_MULTI_ACCESS = 1 }
enum	RouteOrigin {   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_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_STRATEGY,   CONTROL_PARAMETER_EXPIRATION_PERIOD, 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 }

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)
template size_t	ChannelStatus::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	ChannelStatus::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const
static security::SigningInfo	makeSigningInfoFromIdentityCertificate (const Name &certificateName)
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 size_t	StrategyChoice::wireEncode< encoding::EncoderTag > (EncodingImpl< encoding::EncoderTag > &) const
template size_t	StrategyChoice::wireEncode< encoding::EstimatorTag > (EncodingImpl< encoding::EstimatorTag > &) const

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 >
	WireDecodable< StrategyChoice >

Typedef Documentation

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

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

Function Documentation

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

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

References FACE_SCOPE_LOCAL, and FACE_SCOPE_NON_LOCAL.

Referenced by ndn::nfd::RibEntry::end(), ndn::nfd::FaceEventNotification::getKind(), ndn::nfd::FaceQueryFilter::getLinkType(), ndn::nfd::FaceStatus::getNOutBytes(), ndn::nfd::ControlParameters::getPresentFields(), and ndn::nfd::Route::hasInfiniteExpirationPeriod().

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

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

References FACE_PERSISTENCY_ON_DEMAND, FACE_PERSISTENCY_PERMANENT, and FACE_PERSISTENCY_PERSISTENT.

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

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

References LINK_TYPE_MULTI_ACCESS, and LINK_TYPE_POINT_TO_POINT.

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

static security::SigningInfo ndn::nfd::makeSigningInfoFromIdentityCertificate ( const Name &  certificateName )

static

Definition at line 113 of file nfd-command-options.cpp.

References ndn::Data::getName(), ndn::security::signingByCertificate(), and ndn::Name::size().

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

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

Definition at line 186 of file nfd-control-parameters.cpp.

References ndn::nfd::ControlParameters::getCost(), ndn::nfd::ControlParameters::getExpirationPeriod(), ndn::nfd::ControlParameters::getFaceId(), ndn::nfd::ControlParameters::getFlags(), ndn::nfd::ControlParameters::getLocalControlFeature(), ndn::nfd::ControlParameters::getName(), ndn::nfd::ControlParameters::getOrigin(), ndn::nfd::ControlParameters::getStrategy(), ndn::nfd::ControlParameters::getUri(), ndn::nfd::ControlParameters::hasCost(), ndn::nfd::ControlParameters::hasExpirationPeriod(), ndn::nfd::ControlParameters::hasFaceId(), ndn::nfd::ControlParameters::hasFlags(), ndn::nfd::ControlParameters::hasLocalControlFeature(), ndn::nfd::ControlParameters::hasName(), ndn::nfd::ControlParameters::hasOrigin(), ndn::nfd::ControlParameters::hasStrategy(), and ndn::nfd::ControlParameters::hasUri().

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

Definition at line 170 of file nfd-face-event-notification.cpp.

References FACE_EVENT_CREATED, FACE_EVENT_DESTROYED, ndn::nfd::FaceTraits< C >::getFaceId(), ndn::nfd::FaceTraits< C >::getFacePersistency(), ndn::nfd::FaceTraits< C >::getFaceScope(), ndn::nfd::FaceEventNotification::getKind(), ndn::nfd::FaceTraits< C >::getLinkType(), ndn::nfd::FaceTraits< C >::getLocalUri(), and ndn::nfd::FaceTraits< C >::getRemoteUri().

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

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

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

References ndn::nfd::FaceQueryFilter::getFaceId(), ndn::nfd::FaceQueryFilter::getFacePersistency(), ndn::nfd::FaceQueryFilter::getFaceScope(), ndn::nfd::FaceQueryFilter::getLinkType(), ndn::nfd::FaceQueryFilter::getLocalUri(), ndn::nfd::FaceQueryFilter::getRemoteUri(), ndn::nfd::FaceQueryFilter::getUriScheme(), ndn::nfd::FaceQueryFilter::hasFaceId(), ndn::nfd::FaceQueryFilter::hasFacePersistency(), ndn::nfd::FaceQueryFilter::hasFaceScope(), ndn::nfd::FaceQueryFilter::hasLinkType(), ndn::nfd::FaceQueryFilter::hasLocalUri(), ndn::nfd::FaceQueryFilter::hasRemoteUri(), and ndn::nfd::FaceQueryFilter::hasUriScheme().

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

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

Definition at line 295 of file nfd-face-status.cpp.

References ndn::nfd::FaceStatus::getExpirationPeriod(), ndn::nfd::FaceTraits< C >::getFaceId(), ndn::nfd::FaceTraits< C >::getFacePersistency(), ndn::nfd::FaceTraits< C >::getFaceScope(), ndn::nfd::FaceTraits< C >::getLinkType(), ndn::nfd::FaceTraits< C >::getLocalUri(), ndn::nfd::FaceStatus::getNInBytes(), ndn::nfd::FaceStatus::getNInDatas(), ndn::nfd::FaceStatus::getNInInterests(), ndn::nfd::FaceStatus::getNOutBytes(), ndn::nfd::FaceStatus::getNOutDatas(), ndn::nfd::FaceStatus::getNOutInterests(), ndn::nfd::FaceTraits< C >::getRemoteUri(), and ndn::nfd::FaceStatus::hasExpirationPeriod().

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

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::Route::wireEncode< encoding::EncoderTag >

(

EncodingImpl< encoding::EncoderTag > &

block

)

const

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

(

EncodingImpl< encoding::EstimatorTag > &

block

)

const

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

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

References ndn::nfd::Route::getCost(), ndn::nfd::Route::getExpirationPeriod(), ndn::nfd::Route::getFaceId(), ndn::nfd::Route::getFlags(), ndn::nfd::Route::getOrigin(), and ndn::nfd::Route::hasInfiniteExpirationPeriod().

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

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

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

References ndn::nfd::RibEntry::begin(), ndn::nfd::RibEntry::end(), and ndn::nfd::RibEntry::getName().

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 uint64_t ndn::nfd::INVALID_FACE_ID = std::numeric_limits<uint64_t>::max()

static

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

Referenced by ndn::nfd::LocalControlHeader::hasIncomingFaceId(), ndn::nfd::LocalControlHeader::hasNextHopFaceId(), and ndn::nfd::LocalControlHeader::wireDecode().

ndn::nfd::WireEncodable< ChannelStatus >

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

ndn::nfd::WireDecodable< ChannelStatus >

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

ndn::nfd::WireEncodable< ControlParameters >

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

ndn::nfd::WireDecodable< ControlParameters >

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

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

Initial value:

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

Definition at line 49 of file nfd-control-parameters.hpp.

Referenced by ndn::nfd::ControlCommand::FieldValidator::validate().

ndn::nfd::WireEncodable< FaceEventNotification >

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

ndn::nfd::WireDecodable< FaceEventNotification >

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

ndn::nfd::WireEncodable< FaceQueryFilter >

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

ndn::nfd::WireDecodable< FaceQueryFilter >

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

ndn::nfd::WireEncodable< FaceStatus >

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

ndn::nfd::WireDecodable< FaceStatus >

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

ndn::nfd::WireEncodable< NextHopRecord >

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

ndn::nfd::WireDecodable< NextHopRecord >

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

ndn::nfd::WireEncodable< FibEntry >

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

ndn::nfd::WireDecodable< FibEntry >

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

ndn::nfd::WireEncodable< ForwarderStatus >

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

ndn::nfd::WireDecodable< ForwarderStatus >

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

ndn::nfd::WireEncodable< Route >

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

ndn::nfd::WireDecodable< Route >

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

ndn::nfd::WireEncodable< RibEntry >

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

ndn::nfd::WireDecodable< RibEntry >

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

ndn::nfd::WireEncodable< StrategyChoice >

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

ndn::nfd::WireDecodable< StrategyChoice >

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