NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::nfd Namespace Reference

Classes

class  ChannelDataset
 represents a faces/channels dataset More...
 
class  ChannelStatus
 represents an item in NFD Channel dataset More...
 
class  CommandOptions
 contains options for ControlCommand execution More...
 
class  ControlCommand
 base class of NFD ControlCommand More...
 
class  Controller
 NFD Management protocol client. More...
 
class  ControlParameters
 represents parameters in a ControlCommand request or response More...
 
class  FaceCreateCommand
 represents a faces/create command More...
 
class  FaceDataset
 represents a faces/list dataset More...
 
class  FaceDatasetBase
 provides common functionality among FaceDataset and FaceQueryDataset More...
 
class  FaceDestroyCommand
 represents a faces/destroy command More...
 
class  FaceEventNotification
 represents a Face status change notification More...
 
class  FaceMonitor
 A subscriber for Face status change notification stream. More...
 
class  FaceQueryDataset
 represents a faces/query dataset More...
 
class  FaceQueryFilter
 represents Face Query Filter More...
 
class  FaceStatus
 represents an item in NFD Face dataset More...
 
class  FaceTraits
 provides getters and setters for face information fields More...
 
class  FaceUpdateCommand
 represents a faces/update command More...
 
class  FibAddNextHopCommand
 represents a fib/add-nexthop command More...
 
class  FibDataset
 represents a fib/list dataset More...
 
class  FibEntry
 
class  FibRemoveNextHopCommand
 represents a fib/remove-nexthop command More...
 
class  ForwarderGeneralStatusDataset
 represents a status/general dataset More...
 
class  ForwarderStatus
 represents NFD General Status dataset More...
 
class  NextHopRecord
 
class  RibDataset
 represents a rib/list dataset More...
 
class  RibEntry
 represents an item in NFD RIB dataset More...
 
class  RibRegisterCommand
 represents a rib/register command More...
 
class  RibUnregisterCommand
 represents a rib/unregister command More...
 
class  Route
 represents a route in a RibEntry More...
 
class  RouteFlagsTraits
 defines getters for each route inheritance flag More...
 
class  StatusDataset
 base class of NFD StatusDataset More...
 
class  StrategyChoice
 represents an item in NFD StrategyChoice dataset More...
 
class  StrategyChoiceDataset
 represents a strategy-choice/list dataset More...
 
class  StrategyChoiceSetCommand
 represents a strategy-choice/set command More...
 
class  StrategyChoiceUnsetCommand
 represents a strategy-choice/set command More...
 

Typedefs

using ControlResponse = mgmt::ControlResponse
 

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, LINK_TYPE_AD_HOC = 2 }
 
enum  FaceFlagBit { BIT_LOCAL_FIELDS_ENABLED = 0, BIT_LP_RELIABILITY_ENABLED = 1 }
 
enum  FaceEventKind : uint8_t {
  FACE_EVENT_NONE = 0, FACE_EVENT_CREATED = 1, FACE_EVENT_DESTROYED = 2, FACE_EVENT_UP = 3,
  FACE_EVENT_DOWN = 4
}
 
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 : uint64_t { 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_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
}
 

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, FaceEventKind faceEventKind)
 
std::istream & operator>> (std::istream &is, RouteOrigin &routeOrigin)
 extract RouteOrigin from stream More...
 
std::ostream & operator<< (std::ostream &os, RouteOrigin routeOrigin)
 
std::ostream & operator<< (std::ostream &os, RouteFlags routeFlags)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (ChannelStatus)
 
bool operator== (const ChannelStatus &a, const ChannelStatus &b)
 
std::ostream & operator<< (std::ostream &os, const ChannelStatus &status)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (ChannelStatus)
 
bool operator!= (const ChannelStatus &a, const ChannelStatus &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (ControlParameters)
 
std::ostream & operator<< (std::ostream &os, const ControlParameters &parameters)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (ControlParameters)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (FaceEventNotification)
 
bool operator== (const FaceEventNotification &a, const FaceEventNotification &b)
 
std::ostream & operator<< (std::ostream &os, const FaceEventNotification &notification)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (FaceEventNotification)
 
bool operator!= (const FaceEventNotification &a, const FaceEventNotification &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (FaceQueryFilter)
 
bool operator== (const FaceQueryFilter &a, const FaceQueryFilter &b)
 
std::ostream & operator<< (std::ostream &os, const FaceQueryFilter &filter)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (FaceQueryFilter)
 
bool operator!= (const FaceQueryFilter &a, const FaceQueryFilter &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (FaceStatus)
 
bool operator== (const FaceStatus &a, const FaceStatus &b)
 
std::ostream & operator<< (std::ostream &os, const FaceStatus &status)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (FaceStatus)
 
bool operator!= (const FaceStatus &a, const FaceStatus &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (NextHopRecord)
 
bool operator== (const NextHopRecord &a, const NextHopRecord &b)
 
std::ostream & operator<< (std::ostream &os, const NextHopRecord &nh)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (FibEntry)
 
bool operator== (const FibEntry &a, const FibEntry &b)
 
std::ostream & operator<< (std::ostream &os, const FibEntry &entry)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (NextHopRecord)
 
bool operator!= (const NextHopRecord &a, const NextHopRecord &b)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (FibEntry)
 
bool operator!= (const FibEntry &a, const FibEntry &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (ForwarderStatus)
 
bool operator== (const ForwarderStatus &a, const ForwarderStatus &b)
 
std::ostream & operator<< (std::ostream &os, const ForwarderStatus &status)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (ForwarderStatus)
 
bool operator!= (const ForwarderStatus &a, const ForwarderStatus &b)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (Route)
 
bool operator== (const Route &a, const Route &b)
 
std::ostream & operator<< (std::ostream &os, const Route &route)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (RibEntry)
 
bool operator== (const RibEntry &a, const RibEntry &b)
 
std::ostream & operator<< (std::ostream &os, const RibEntry &entry)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (Route)
 
bool operator!= (const Route &a, const Route &b)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (RibEntry)
 
bool operator!= (const RibEntry &a, const RibEntry &b)
 
template<typename T >
static std::vector< T > parseDatasetVector (ConstBufferPtr payload)
 parses elements into a vector of T More...
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (StrategyChoice)
 
bool operator== (const StrategyChoice &a, const StrategyChoice &b)
 
std::ostream & operator<< (std::ostream &os, const StrategyChoice &sc)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (StrategyChoice)
 
bool operator!= (const StrategyChoice &a, const StrategyChoice &b)
 

Variables

const uint64_t INVALID_FACE_ID = 0
 
 StatusDatasetItem< ChannelStatus >
 
 WireEncodable< ControlParameters >
 
 WireDecodable< ControlParameters >
 
const std::string CONTROL_PARAMETER_FIELD [CONTROL_PARAMETER_UBOUND]
 
 NotificationStreamItem< FaceEventNotification >
 
 WireEncodable< FaceQueryFilter >
 
 WireDecodable< FaceQueryFilter >
 
 StatusDatasetItem< FaceStatus >
 
 StatusDatasetItem< NextHopRecord >
 
 StatusDatasetItem< FibEntry >
 
 StatusDatasetItem< ForwarderStatus >
 
 StatusDatasetItem< Route >
 
 StatusDatasetItem< RibEntry >
 
 StatusDatasetItem< StrategyChoice >
 

Typedef Documentation

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

Function Documentation

std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
FaceScope  faceScope 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
FacePersistency  facePersistency 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
LinkType  linkType 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
FaceEventKind  faceEventKind 
)
std::istream & ndn::nfd::operator>> ( std::istream &  is,
RouteOrigin routeOrigin 
)

extract RouteOrigin from stream

Postcondition
if the first token in contains a valid RouteOrigin as string or numeric value, it is extracted into routeOrigin ; otherwise, routeOrigin is set to ROUTE_ORIGIN_NONE , and failbit is set on is

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

References ROUTE_ORIGIN_APP, ROUTE_ORIGIN_AUTOCONF, ROUTE_ORIGIN_AUTOREG, ROUTE_ORIGIN_CLIENT, ROUTE_ORIGIN_NLSR, ROUTE_ORIGIN_NONE, and ROUTE_ORIGIN_STATIC.

std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
RouteOrigin  routeOrigin 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
RouteFlags  routeFlags 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
const ChannelStatus status 
)

Definition at line 102 of file channel-status.cpp.

References ndn::nfd::ChannelStatus::getLocalUri().

bool ndn::nfd::operator!= ( const ChannelStatus a,
const ChannelStatus b 
)
inline

Definition at line 85 of file channel-status.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( ControlParameters  )
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( ControlParameters  )
ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( FaceEventNotification  )
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( FaceEventNotification  )
bool ndn::nfd::operator!= ( const FaceEventNotification a,
const FaceEventNotification b 
)
inline

Definition at line 79 of file face-event-notification.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( FaceQueryFilter  )
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( FaceQueryFilter  )
bool ndn::nfd::operator!= ( const FaceQueryFilter a,
const FaceQueryFilter b 
)
inline

Definition at line 227 of file face-query-filter.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( FaceStatus  )
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( FaceStatus  )
bool ndn::nfd::operator!= ( const FaceStatus a,
const FaceStatus b 
)
inline

Definition at line 170 of file face-status.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( NextHopRecord  )
bool ndn::nfd::operator== ( const NextHopRecord a,
const NextHopRecord b 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
const NextHopRecord nh 
)
ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( FibEntry  )
bool ndn::nfd::operator== ( const FibEntry a,
const FibEntry b 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
const FibEntry entry 
)
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( NextHopRecord  )
bool ndn::nfd::operator!= ( const NextHopRecord a,
const NextHopRecord b 
)
inline

Definition at line 93 of file fib-entry.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( FibEntry  )
bool ndn::nfd::operator!= ( const FibEntry a,
const FibEntry b 
)
inline

Definition at line 176 of file fib-entry.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( ForwarderStatus  )
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( ForwarderStatus  )
bool ndn::nfd::operator!= ( const ForwarderStatus a,
const ForwarderStatus b 
)
inline

Definition at line 228 of file forwarder-status.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( Route  )
ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( RibEntry  )
bool ndn::nfd::operator== ( const RibEntry a,
const RibEntry b 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
const RibEntry entry 
)
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( Route  )
bool ndn::nfd::operator!= ( const Route a,
const Route b 
)
inline

Definition at line 140 of file rib-entry.hpp.

References operator<<().

ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( RibEntry  )
bool ndn::nfd::operator!= ( const RibEntry a,
const RibEntry b 
)
inline

Definition at line 228 of file rib-entry.hpp.

References operator<<().

template<typename T >
static std::vector<T> ndn::nfd::parseDatasetVector ( ConstBufferPtr  payload)
static

parses elements into a vector of T

Template Parameters
Telement type
Parameters
payloadpointer to a buffer of zero or more blocks of decodable by T
Returns
a vector of T
Exceptions
tlv::Errorcannot parse payload

Definition at line 58 of file status-dataset.cpp.

References ndn::Block::fromBuffer(), and ndn::Block::size().

ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( StrategyChoice  )
bool ndn::nfd::operator== ( const StrategyChoice a,
const StrategyChoice b 
)
std::ostream & ndn::nfd::operator<< ( std::ostream &  os,
const StrategyChoice sc 
)
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( StrategyChoice  )
bool ndn::nfd::operator!= ( const StrategyChoice a,
const StrategyChoice b 
)
inline

Definition at line 96 of file strategy-choice.hpp.

References operator<<().

Variable Documentation

ndn::nfd::StatusDatasetItem< ChannelStatus >

Definition at line 30 of file channel-status.cpp.

ndn::nfd::WireEncodable< ControlParameters >

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

ndn::nfd::WireDecodable< ControlParameters >

Definition at line 33 of file control-parameters.cpp.

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

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

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

ndn::nfd::NotificationStreamItem< FaceEventNotification >

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

ndn::nfd::WireEncodable< FaceQueryFilter >

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

ndn::nfd::WireDecodable< FaceQueryFilter >

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

ndn::nfd::StatusDatasetItem< FaceStatus >

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

ndn::nfd::StatusDatasetItem< NextHopRecord >

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

ndn::nfd::StatusDatasetItem< FibEntry >

Definition at line 34 of file fib-entry.cpp.

ndn::nfd::StatusDatasetItem< ForwarderStatus >

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

ndn::nfd::StatusDatasetItem< Route >

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

ndn::nfd::StatusDatasetItem< RibEntry >

Definition at line 35 of file rib-entry.cpp.

ndn::nfd::StatusDatasetItem< StrategyChoice >

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