ndn::nfd::RibAnnounceCommand Class Reference

Represents a rib/announce command. More...

#include <ndn-cxx/mgmt/nfd/control-command.hpp>

Inheritance diagram for ndn::nfd::RibAnnounceCommand:

Collaboration diagram for ndn::nfd::RibAnnounceCommand:

Public Types
using	RequestFormat = ApplicationParametersCommandFormat< RibAnnounceParameters >
using	RequestParameters = typename RequestFormat::ParametersType
using	ResponseFormat = ControlParametersCommandFormat
using	ResponseParameters = typename ResponseFormat::ParametersType

Static Public Member Functions
static void	applyDefaultsToRequest (RequestParameters &params)
	Apply default values to missing fields in request.
static void	applyDefaultsToResponse (ResponseParameters &params)
	Apply default values to missing fields in response.
static Interest	createRequest (Name commandPrefix, const RequestParameters &params)
	Construct request Interest.
static PartialName	getName ()
	Return the command name (module + verb).
static shared_ptr< mgmt::ControlParametersBase >	parseRequest (const Interest &interest, size_t prefixLen)
	Extract parameters from request Interest.
static void	validateRequest (const RequestParameters &params)
	Validate request parameters.
static void	validateResponse (const ResponseParameters &params)
	Validate response parameters.

Static Public Attributes
static const ::ndn::name::Component	module {std::string_view( "rib" )}
static const ::ndn::name::Component	verb {std::string_view( "announce" )}

Detailed Description

Represents a rib/announce command.

See also

https://redmine.named-data.net/projects/nfd/wiki/RibMgmt#Register-a-route-with-Prefix-Announcement-object

Definition at line 500 of file control-command.hpp.

Member Typedef Documentation

RequestFormat

using ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::RequestFormat = ApplicationParametersCommandFormat< RibAnnounceParameters >

inherited

Definition at line 166 of file control-command.hpp.

RequestParameters

using ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::RequestParameters = typename RequestFormat::ParametersType

inherited

Definition at line 168 of file control-command.hpp.

ResponseFormat

using ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::ResponseFormat = ControlParametersCommandFormat

inherited

Definition at line 167 of file control-command.hpp.

ResponseParameters

using ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::ResponseParameters = typename ResponseFormat::ParametersType

inherited

Definition at line 169 of file control-command.hpp.

Member Function Documentation

applyDefaultsToRequest()

static void ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::applyDefaultsToRequest ( RequestParameters &  params )

inlinestaticinherited

Apply default values to missing fields in request.

Definition at line 221 of file control-command.hpp.

applyDefaultsToResponse()

static void ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::applyDefaultsToResponse ( ResponseParameters &  params )

inlinestaticinherited

Apply default values to missing fields in response.

Definition at line 241 of file control-command.hpp.

createRequest()

static Interest ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::createRequest ( Name  commandPrefix, const RequestParameters &  params  )

inlinestaticinherited

Construct request Interest.

Exceptions

ArgumentError

if parameters are invalid

Definition at line 187 of file control-command.hpp.

getName()

static PartialName ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::getName ( )

inlinestaticinherited

Return the command name (module + verb).

Definition at line 177 of file control-command.hpp.

parseRequest()

static shared_ptr< mgmt::ControlParametersBase > ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::parseRequest ( const Interest &  interest, size_t  prefixLen  )

inlinestaticinherited

Extract parameters from request Interest.

Definition at line 200 of file control-command.hpp.

validateRequest()

static void ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::validateRequest ( const RequestParameters &  params )

inlinestaticinherited

Validate request parameters.

Exceptions

ArgumentError

if parameters are invalid

Definition at line 211 of file control-command.hpp.

validateResponse()

static void ndn::nfd::ControlCommand< RibAnnounceCommand , ApplicationParametersCommandFormat< RibAnnounceParameters > , ControlParametersCommandFormat >::validateResponse ( const ResponseParameters &  params )

inlinestaticinherited

Validate response parameters.

Exceptions

ArgumentError

if parameters are invalid

Definition at line 231 of file control-command.hpp.

Member Data Documentation

module

const ::ndn::name::Component ndn::nfd::RibAnnounceCommand::module {std::string_view( "rib" )}

inlinestatic

Definition at line 503 of file control-command.hpp.

verb

const ::ndn::name::Component ndn::nfd::RibAnnounceCommand::verb {std::string_view( "announce" )}

inlinestatic

Definition at line 503 of file control-command.hpp.