NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Management

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

Classes

class  ndn::nfd::ChannelStatus
 represents an item in NFD Channel 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::FaceUpdateCommand
 represents a faces/update command More...
 
class  ndn::nfd::FaceDestroyCommand
 represents a faces/destroy 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 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 an item in NFD Face dataset More...
 
class  ndn::nfd::FaceTraits< C >
 provides getters and setters for face information fields More...
 
class  ndn::nfd::NextHopRecord
 
class  ndn::nfd::FibEntry
 
class  ndn::nfd::ForwarderStatus
 represents NFD General Status dataset More...
 
class  ndn::nfd::Route
 represents a route in a RibEntry More...
 
class  ndn::nfd::RibEntry
 represents an item in NFD RIB dataset More...
 
class  ndn::nfd::RouteFlagsTraits< T >
 defines getters for each route inheritance flag More...
 
class  ndn::nfd::StatusDataset
 base class of NFD StatusDataset More...
 
class  ndn::nfd::ForwarderGeneralStatusDataset
 represents a status/general dataset More...
 
class  ndn::nfd::FaceDatasetBase
 provides common functionality among FaceDataset and FaceQueryDataset More...
 
class  ndn::nfd::FaceDataset
 represents a faces/list dataset More...
 
class  ndn::nfd::FaceQueryDataset
 represents a faces/query dataset More...
 
class  ndn::nfd::ChannelDataset
 represents a faces/channels dataset More...
 
class  ndn::nfd::FibDataset
 represents a fib/list dataset More...
 
class  ndn::nfd::StrategyChoiceDataset
 represents a strategy-choice/list dataset More...
 
class  ndn::nfd::RibDataset
 represents a rib/list dataset More...
 
class  ndn::nfd::StrategyChoice
 represents an item in 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, ndn::nfd::LINK_TYPE_AD_HOC = 2 }
 
enum  ndn::nfd::FaceFlagBit { ndn::nfd::BIT_LOCAL_FIELDS_ENABLED = 0, ndn::nfd::BIT_LP_RELIABILITY_ENABLED = 1 }
 
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::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 : uint64_t { 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_URI,
  ndn::nfd::CONTROL_PARAMETER_ORIGIN, ndn::nfd::CONTROL_PARAMETER_COST, 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_UBOUND
}
 

Detailed Description

Classes and data structures to manage NDN forwarder.

Enumeration Type Documentation

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.

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 45 of file nfd-constants.hpp.

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 57 of file nfd-constants.hpp.

Enumerator
BIT_LOCAL_FIELDS_ENABLED 

controls whether local fields are enabled on a face

BIT_LP_RELIABILITY_ENABLED 

controls whether the link reliability feature is enabled on a face

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

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 76 of file nfd-constants.hpp.

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 89 of file nfd-constants.hpp.

enum ndn::nfd::RouteFlags : uint64_t
Enumerator
ROUTE_FLAGS_NONE 
ROUTE_FLAG_CHILD_INHERIT 
ROUTE_FLAG_CAPTURE 

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

Enumerator
CONTROL_PARAMETER_NAME 
CONTROL_PARAMETER_FACE_ID 
CONTROL_PARAMETER_URI 
CONTROL_PARAMETER_LOCAL_URI 
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 

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