NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
Management

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

Classes

class  ndn::nfd::ChannelStatus
 represents NFD Channel Status dataset More...
 
class  ndn::nfd::CommandOptions
 contains options for ControlCommand execution More...
 
class  ndn::nfd::ControlCommand
 base class of NFD ControlCommand More...
 
class  ndn::nfd::FaceCreateCommand
 represents a faces/create command More...
 
class  ndn::nfd::FaceDestroyCommand
 represents a faces/destroy command More...
 
class  ndn::nfd::FaceLocalControlCommand
 Base class for faces/[*]-local-control commands. More...
 
class  ndn::nfd::FaceEnableLocalControlCommand
 represents a faces/enable-local-control command More...
 
class  ndn::nfd::FaceDisableLocalControlCommand
 represents a faces/disable-local-control command More...
 
class  ndn::nfd::FibAddNextHopCommand
 represents a fib/add-nexthop command More...
 
class  ndn::nfd::FibRemoveNextHopCommand
 represents a fib/remove-nexthop command More...
 
class  ndn::nfd::StrategyChoiceSetCommand
 represents a strategy-choice/set command More...
 
class  ndn::nfd::StrategyChoiceUnsetCommand
 represents a strategy-choice/set command More...
 
class  ndn::nfd::RibRegisterCommand
 represents a rib/register command More...
 
class  ndn::nfd::RibUnregisterCommand
 represents a rib/unregister command More...
 
class  ndn::nfd::ControlParameters
 represents parameters in a ControlCommand request or response More...
 
class  ndn::nfd::Controller
 NFD Management protocol - ControlCommand client. More...
 
class  ndn::nfd::FaceEventNotification
 represents a Face status change notification More...
 
class  ndn::nfd::FaceQueryFilter
 represents Face Query Filter More...
 
class  ndn::nfd::FaceStatus
 represents Face status More...
 
class  ndn::nfd::FaceTraits< C >
 providers getters and setters of face information fields More...
 
class  ndn::nfd::NextHopRecord
 
class  ndn::nfd::FibEntry
 
class  ndn::nfd::ForwarderStatus
 represents NFD Forwarder Status More...
 
class  ndn::nfd::Route
 Data abstraction for Route. More...
 
class  ndn::nfd::RibEntry
 Data abstraction for RIB entry. More...
 
class  ndn::nfd::RibFlagsTraits< T >
 implements getters to each RIB flag More...
 
class  ndn::nfd::StrategyChoice
 represents NFD StrategyChoice dataset More...
 

Enumerations

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::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::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 }
 
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_STATIC = 255
}
 
enum  ndn::nfd::RouteFlags { ndn::nfd::ROUTE_FLAGS_NONE = 0, ndn::nfd::ROUTE_FLAG_CHILD_INHERIT = 1, ndn::nfd::ROUTE_FLAG_CAPTURE = 2 }
 
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_CONTROL_FEATURE,
  ndn::nfd::CONTROL_PARAMETER_ORIGIN, ndn::nfd::CONTROL_PARAMETER_COST, ndn::nfd::CONTROL_PARAMETER_FLAGS, ndn::nfd::CONTROL_PARAMETER_STRATEGY,
  ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD, ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY, ndn::nfd::CONTROL_PARAMETER_UBOUND
}
 
enum  ndn::nfd::LocalControlFeature { ndn::nfd::LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID = 1, ndn::nfd::LOCAL_CONTROL_FEATURE_NEXT_HOP_FACE_ID = 2 }
 
enum  ndn::nfd::FaceEventKind { ndn::nfd::FACE_EVENT_CREATED = 1, ndn::nfd::FACE_EVENT_DESTROYED = 2 }
 

Detailed Description

Classes and data structures to manage NDN forwarder.

Enumeration Type Documentation

§ 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 34 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 49 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

Definition at line 67 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_STATIC 

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

§ RouteFlags

Enumerator
ROUTE_FLAGS_NONE 
ROUTE_FLAG_CHILD_INHERIT 
ROUTE_FLAG_CAPTURE 

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

§ ControlParameterField

Enumerator
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_FACE_PERSISTENCY 
CONTROL_PARAMETER_UBOUND 

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

§ LocalControlFeature

Enumerator
LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID 
LOCAL_CONTROL_FEATURE_NEXT_HOP_FACE_ID 

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

§ FaceEventKind

Enumerator
FACE_EVENT_CREATED 
FACE_EVENT_DESTROYED 

Definition at line 34 of file nfd-face-event-notification.hpp.