Management

Classes and data structures to manage an NDN forwarder. More...

Typedefs
using	ndn::nfd::CommandFailureCallback = std::function< void(const ControlResponse &)>
	Callback on command failure. More...
using	ndn::nfd::CommandSuccessCallback = std::function< void(const ControlParameters &)>
	Callback on command success. More...
using	ndn::nfd::DatasetFailureCallback = std::function< void(uint32_t code, const std::string &reason)>
	Callback on dataset retrieval failure. More...
template<typename Dataset >
using	ndn::nfd::DatasetSuccessCallback = std::function< void(const std::invoke_result_t< decltype(&Dataset::parseResult), Dataset, ConstBufferPtr > &)>
	Callback on dataset retrieval success. More...

Enumerations
enum	ndn::nfd::ControlParameterField {   ndn::nfd::CONTROL_PARAMETER_NAME ,   ndn::nfd::CONTROL_PARAMETER_FACE_ID ,   ndn::nfd::CONTROL_PARAMETER_URI ,   ndn::nfd::CONTROL_PARAMETER_LOCAL_URI ,   ndn::nfd::CONTROL_PARAMETER_ORIGIN ,   ndn::nfd::CONTROL_PARAMETER_COST ,   ndn::nfd::CONTROL_PARAMETER_CAPACITY ,   ndn::nfd::CONTROL_PARAMETER_COUNT ,   ndn::nfd::CONTROL_PARAMETER_FLAGS ,   ndn::nfd::CONTROL_PARAMETER_MASK ,   ndn::nfd::CONTROL_PARAMETER_STRATEGY ,   ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD ,   ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY ,   ndn::nfd::CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL ,   ndn::nfd::CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD ,   ndn::nfd::CONTROL_PARAMETER_MTU ,   ndn::nfd::CONTROL_PARAMETER_UBOUND }
enum	ndn::nfd::CsFlagBit {   ndn::nfd::BIT_CS_ENABLE_ADMIT = 0 ,   ndn::nfd::BIT_CS_ENABLE_SERVE = 1 }
	CS enablement flags. More...
enum	ndn::nfd::FaceEventKind : uint8_t {   ndn::nfd::FACE_EVENT_NONE = 0 ,   ndn::nfd::FACE_EVENT_CREATED = 1 ,   ndn::nfd::FACE_EVENT_DESTROYED = 2 ,   ndn::nfd::FACE_EVENT_UP = 3 ,   ndn::nfd::FACE_EVENT_DOWN = 4 }
enum	ndn::nfd::FaceFlagBit {   ndn::nfd::BIT_LOCAL_FIELDS_ENABLED = 0 ,   ndn::nfd::BIT_LP_RELIABILITY_ENABLED = 1 ,   ndn::nfd::BIT_CONGESTION_MARKING_ENABLED = 2 }
enum	ndn::nfd::FacePersistency : uint8_t {   ndn::nfd::FACE_PERSISTENCY_NONE = std::numeric_limits<uint8_t>::max() ,   ndn::nfd::FACE_PERSISTENCY_PERSISTENT = 0 ,   ndn::nfd::FACE_PERSISTENCY_ON_DEMAND = 1 ,   ndn::nfd::FACE_PERSISTENCY_PERMANENT = 2 }
enum	ndn::nfd::FaceScope : uint8_t {   ndn::nfd::FACE_SCOPE_NONE = std::numeric_limits<uint8_t>::max() ,   ndn::nfd::FACE_SCOPE_NON_LOCAL = 0 ,   ndn::nfd::FACE_SCOPE_LOCAL = 1 }
enum	ndn::nfd::LinkType : uint8_t {   ndn::nfd::LINK_TYPE_NONE = std::numeric_limits<uint8_t>::max() ,   ndn::nfd::LINK_TYPE_POINT_TO_POINT = 0 ,   ndn::nfd::LINK_TYPE_MULTI_ACCESS = 1 ,   ndn::nfd::LINK_TYPE_AD_HOC = 2 }
enum	ndn::nfd::RouteFlags : uint64_t {   ndn::nfd::ROUTE_FLAGS_NONE = 0 ,   ndn::nfd::ROUTE_FLAG_CHILD_INHERIT = 1 ,   ndn::nfd::ROUTE_FLAG_CAPTURE = 2 }
enum	ndn::nfd::RouteOrigin : uint16_t {   ndn::nfd::ROUTE_ORIGIN_NONE = std::numeric_limits<uint16_t>::max() ,   ndn::nfd::ROUTE_ORIGIN_APP = 0 ,   ndn::nfd::ROUTE_ORIGIN_AUTOREG = 64 ,   ndn::nfd::ROUTE_ORIGIN_CLIENT = 65 ,   ndn::nfd::ROUTE_ORIGIN_AUTOCONF = 66 ,   ndn::nfd::ROUTE_ORIGIN_NLSR = 128 ,   ndn::nfd::ROUTE_ORIGIN_PREFIXANN = 129 ,   ndn::nfd::ROUTE_ORIGIN_STATIC = 255 }

Detailed Description

Classes and data structures to manage an NDN forwarder.

Typedef Documentation

CommandFailureCallback

using ndn::nfd::CommandFailureCallback = typedef std::function<void(const ControlResponse&)>

Callback on command failure.

Definition at line 57 of file controller.hpp.

CommandSuccessCallback

using ndn::nfd::CommandSuccessCallback = typedef std::function<void(const ControlParameters&)>

Callback on command success.

Definition at line 51 of file controller.hpp.

DatasetFailureCallback

using ndn::nfd::DatasetFailureCallback = typedef std::function<void(uint32_t code, const std::string& reason)>

Callback on dataset retrieval failure.

Definition at line 71 of file controller.hpp.

DatasetSuccessCallback

template<typename Dataset >

using ndn::nfd::DatasetSuccessCallback = typedef std::function<void(const std::invoke_result_t<decltype(&Dataset::parseResult), Dataset, ConstBufferPtr>&)>

Callback on dataset retrieval success.

Definition at line 64 of file controller.hpp.

Enumeration Type Documentation

ControlParameterField

enum ndn::nfd::ControlParameterField

Enumerator
CONTROL_PARAMETER_NAME
CONTROL_PARAMETER_FACE_ID
CONTROL_PARAMETER_URI
CONTROL_PARAMETER_LOCAL_URI
CONTROL_PARAMETER_ORIGIN
CONTROL_PARAMETER_COST
CONTROL_PARAMETER_CAPACITY
CONTROL_PARAMETER_COUNT
CONTROL_PARAMETER_FLAGS
CONTROL_PARAMETER_MASK
CONTROL_PARAMETER_STRATEGY
CONTROL_PARAMETER_EXPIRATION_PERIOD
CONTROL_PARAMETER_FACE_PERSISTENCY
CONTROL_PARAMETER_BASE_CONGESTION_MARKING_INTERVAL
CONTROL_PARAMETER_DEFAULT_CONGESTION_THRESHOLD
CONTROL_PARAMETER_MTU
CONTROL_PARAMETER_UBOUND

Definition at line 35 of file control-parameters.hpp.

CsFlagBit

enum ndn::nfd::CsFlagBit

CS enablement flags.

See also

https://redmine.named-data.net/projects/nfd/wiki/CsMgmt#Update-config

Enumerator
BIT_CS_ENABLE_ADMIT	enables the CS to admit new Data
BIT_CS_ENABLE_SERVE	enables the CS to satisfy Interests using cached Data

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

FaceEventKind

enum ndn::nfd::FaceEventKind : uint8_t

Enumerator
FACE_EVENT_NONE
FACE_EVENT_CREATED	face was created
FACE_EVENT_DESTROYED	face was destroyed
FACE_EVENT_UP	face went UP (from DOWN state)
FACE_EVENT_DOWN	face went DOWN (from UP state)

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

FaceFlagBit

enum ndn::nfd::FaceFlagBit

Enumerator
BIT_LOCAL_FIELDS_ENABLED	whether local fields are enabled on a face
BIT_LP_RELIABILITY_ENABLED	whether the link reliability feature is enabled on a face
BIT_CONGESTION_MARKING_ENABLED	whether congestion detection and marking is enabled on a face

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

FacePersistency

enum ndn::nfd::FacePersistency : uint8_t

Enumerator
FACE_PERSISTENCY_NONE
FACE_PERSISTENCY_PERSISTENT	face is persistent
FACE_PERSISTENCY_ON_DEMAND	face is on-demand
FACE_PERSISTENCY_PERMANENT	face is permanent

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

FaceScope

enum ndn::nfd::FaceScope : uint8_t

Enumerator
FACE_SCOPE_NONE
FACE_SCOPE_NON_LOCAL	face is non-local
FACE_SCOPE_LOCAL	face is local

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

LinkType

enum ndn::nfd::LinkType : uint8_t

Enumerator
LINK_TYPE_NONE
LINK_TYPE_POINT_TO_POINT	link is point-to-point
LINK_TYPE_MULTI_ACCESS	link is multi-access
LINK_TYPE_AD_HOC	link is ad hoc

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

RouteFlags

enum ndn::nfd::RouteFlags : uint64_t

Enumerator
ROUTE_FLAGS_NONE
ROUTE_FLAG_CHILD_INHERIT
ROUTE_FLAG_CAPTURE

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

RouteOrigin

enum ndn::nfd::RouteOrigin : uint16_t

Enumerator
ROUTE_ORIGIN_NONE
ROUTE_ORIGIN_APP
ROUTE_ORIGIN_AUTOREG
ROUTE_ORIGIN_CLIENT
ROUTE_ORIGIN_AUTOCONF
ROUTE_ORIGIN_NLSR
ROUTE_ORIGIN_PREFIXANN
ROUTE_ORIGIN_STATIC

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