NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
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  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
 
typedef ndn::lp::LocalControlHeaderFacade LocalControlHeader
 

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  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_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 }
 

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

§ ControlResponse

§ LocalControlHeader

Function Documentation

§ operator<<() [1/11]

§ operator<<() [2/11]

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

§ operator<<() [3/11]

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

§ operator<<() [4/11]

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

§ operator<<() [5/11]

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

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

References ROUTE_FLAG_CAPTURE, ROUTE_FLAG_CHILD_INHERIT, and ROUTE_FLAGS_NONE.

§ ChannelStatus::wireEncode< encoding::EncoderTag >()

§ ChannelStatus::wireEncode< encoding::EstimatorTag >()

§ makeSigningInfoFromIdentityCertificate()

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

§ ControlParameters::wireEncode< encoding::EncoderTag >()

§ ControlParameters::wireEncode< encoding::EstimatorTag >()

§ operator<<() [6/11]

§ operator<<() [7/11]

§ FaceQueryFilter::wireEncode< encoding::EncoderTag >()

§ FaceQueryFilter::wireEncode< encoding::EstimatorTag >()

§ operator<<() [8/11]

§ FaceStatus::wireEncode< encoding::EncoderTag >()

§ FaceStatus::wireEncode< encoding::EstimatorTag >()

§ operator<<() [9/11]

§ NextHopRecord::wireEncode< encoding::EncoderTag >()

§ NextHopRecord::wireEncode< encoding::EstimatorTag >()

§ FibEntry::wireEncode< encoding::EncoderTag >()

§ FibEntry::wireEncode< encoding::EstimatorTag >()

§ ForwarderStatus::wireEncode< encoding::EncoderTag >()

§ ForwarderStatus::wireEncode< encoding::EstimatorTag >()

§ Route::wireEncode< encoding::EncoderTag >()

§ Route::wireEncode< encoding::EstimatorTag >()

§ operator<<() [10/11]

§ RibEntry::wireEncode< encoding::EncoderTag >()

§ RibEntry::wireEncode< encoding::EstimatorTag >()

§ operator<<() [11/11]

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

§ StrategyChoice::wireEncode< encoding::EncoderTag >()

§ StrategyChoice::wireEncode< encoding::EstimatorTag >()

Variable Documentation

§ INVALID_FACE_ID

§ WireEncodable< ChannelStatus >

ndn::nfd::WireEncodable< ChannelStatus >

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

§ WireDecodable< ChannelStatus >

ndn::nfd::WireDecodable< ChannelStatus >

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

§ WireEncodable< ControlParameters >

ndn::nfd::WireEncodable< ControlParameters >

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

§ WireDecodable< ControlParameters >

ndn::nfd::WireDecodable< ControlParameters >

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

§ CONTROL_PARAMETER_FIELD

const std::string ndn::nfd::CONTROL_PARAMETER_FIELD[CONTROL_PARAMETER_UBOUND]
Initial value:
= {
"Name",
"FaceId",
"Uri",
"LocalControlFeature",
"Origin",
"Cost",
"Flags",
"Strategy",
"ExpirationPeriod",
"FacePersistency",
}

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

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

§ WireEncodable< FaceEventNotification >

ndn::nfd::WireEncodable< FaceEventNotification >

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

§ WireDecodable< FaceEventNotification >

ndn::nfd::WireDecodable< FaceEventNotification >

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

§ WireEncodable< FaceQueryFilter >

ndn::nfd::WireEncodable< FaceQueryFilter >

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

§ WireDecodable< FaceQueryFilter >

ndn::nfd::WireDecodable< FaceQueryFilter >

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

§ WireEncodable< FaceStatus >

ndn::nfd::WireEncodable< FaceStatus >

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

§ WireDecodable< FaceStatus >

ndn::nfd::WireDecodable< FaceStatus >

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

§ WireEncodable< NextHopRecord >

ndn::nfd::WireEncodable< NextHopRecord >

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

§ WireDecodable< NextHopRecord >

ndn::nfd::WireDecodable< NextHopRecord >

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

§ WireEncodable< FibEntry >

ndn::nfd::WireEncodable< FibEntry >

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

§ WireDecodable< FibEntry >

ndn::nfd::WireDecodable< FibEntry >

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

§ WireEncodable< ForwarderStatus >

ndn::nfd::WireEncodable< ForwarderStatus >

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

§ WireDecodable< ForwarderStatus >

ndn::nfd::WireDecodable< ForwarderStatus >

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

§ WireEncodable< Route >

ndn::nfd::WireEncodable< Route >

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

§ WireDecodable< Route >

ndn::nfd::WireDecodable< Route >

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

§ WireEncodable< RibEntry >

ndn::nfd::WireEncodable< RibEntry >

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

§ WireDecodable< RibEntry >

ndn::nfd::WireDecodable< RibEntry >

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

§ WireEncodable< StrategyChoice >

ndn::nfd::WireEncodable< StrategyChoice >

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

§ WireDecodable< StrategyChoice >

ndn::nfd::WireDecodable< StrategyChoice >

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