Public Types | Static Public Member Functions | Static Public Attributes | List of all members
ndn::nfd::FibRemoveNextHopCommand Class Reference

Represents a fib/remove-nexthop command. More...

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

+ Inheritance diagram for ndn::nfd::FibRemoveNextHopCommand:
+ Collaboration diagram for ndn::nfd::FibRemoveNextHopCommand:

Public Types

using RequestFormat = ControlParametersCommandFormat
 
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. More...
 
static void applyDefaultsToResponse (ResponseParameters &params)
 Apply default values to missing fields in response. More...
 
static Interest createRequest (Name commandPrefix, const RequestParameters &params)
 Construct request Interest. More...
 
static PartialName getName ()
 Return the command name (module + verb). More...
 
static shared_ptr< mgmt::ControlParametersBase > parseRequest (const Interest &interest, size_t prefixLen)
 Extract parameters from request Interest. More...
 
static void validateRequest (const RequestParameters &params)
 Validate request parameters. More...
 
static void validateResponse (const ResponseParameters &params)
 Validate response parameters. More...
 

Static Public Attributes

static const ::ndn::name::Component module {std::string_view( "fib" )}
 
static const ::ndn::name::Component verb {std::string_view( "remove-nexthop" )}
 

Detailed Description

Represents a fib/remove-nexthop command.

See also
https://redmine.named-data.net/projects/nfd/wiki/FibMgmt#Remove-a-nexthop

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

Member Typedef Documentation

◆ RequestFormat

using ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::RequestFormat = ControlParametersCommandFormat
inherited

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

◆ RequestParameters

using ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::RequestParameters = typename RequestFormat::ParametersType
inherited

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

◆ ResponseFormat

using ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::ResponseFormat = ControlParametersCommandFormat
inherited

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

◆ ResponseParameters

using ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::ResponseParameters = typename ResponseFormat::ParametersType
inherited

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

Member Function Documentation

◆ applyDefaultsToRequest()

static void ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , 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< FibRemoveNextHopCommand , ControlParametersCommandFormat , 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< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::createRequest ( Name  commandPrefix,
const RequestParameters &  params 
)
inlinestaticinherited

Construct request Interest.

Exceptions
ArgumentErrorif parameters are invalid

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

◆ getName()

static PartialName ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , 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< FibRemoveNextHopCommand , ControlParametersCommandFormat , 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< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::validateRequest ( const RequestParameters &  params)
inlinestaticinherited

Validate request parameters.

Exceptions
ArgumentErrorif parameters are invalid

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

◆ validateResponse()

static void ndn::nfd::ControlCommand< FibRemoveNextHopCommand , ControlParametersCommandFormat , ControlParametersCommandFormat >::validateResponse ( const ResponseParameters &  params)
inlinestaticinherited

Validate response parameters.

Exceptions
ArgumentErrorif parameters are invalid

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

Member Data Documentation

◆ module

const ::ndn::name::Component ndn::nfd::FibRemoveNextHopCommand::module {std::string_view( "fib" )}
inlinestatic

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

◆ verb

const ::ndn::name::Component ndn::nfd::FibRemoveNextHopCommand::verb {std::string_view( "remove-nexthop" )}
inlinestatic

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