ndn::nfd::ApplicationParametersCommandFormat< PT > Class Template Reference

Implements decoding, encoding, and validation of control command parameters carried in the ApplicationParameters of the request (Interest packet). More...

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

Public Types

using ParametersType = PT
 

Public Member Functions

void validate (const ParametersType &) const
 Does nothing. More...
 

Static Public Member Functions

static shared_ptr< ParametersTypedecode (const Interest &interest, size_t prefixLen=0)
 Extract the parameters from the request interest. More...
 
static void encode (Interest &interest, const ParametersType &params)
 Serialize the parameters into the request interest. More...
 

Detailed Description

template<typename PT>
class ndn::nfd::ApplicationParametersCommandFormat< PT >

Implements decoding, encoding, and validation of control command parameters carried in the ApplicationParameters of the request (Interest packet).

Note
This format is applicable to control command requests only.

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

Member Typedef Documentation

◆ ParametersType

template<typename PT >
using ndn::nfd::ApplicationParametersCommandFormat< PT >::ParametersType = PT

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

Member Function Documentation

◆ decode()

template<typename PT >
static shared_ptr<ParametersType> ndn::nfd::ApplicationParametersCommandFormat< PT >::decode ( const Interest interest,
size_t  prefixLen = 0 
)
inlinestatic

Extract the parameters from the request interest.

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

◆ encode()

template<typename PT >
static void ndn::nfd::ApplicationParametersCommandFormat< PT >::encode ( Interest interest,
const ParametersType params 
)
inlinestatic

Serialize the parameters into the request interest.

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

◆ validate()

template<typename PT >
void ndn::nfd::ApplicationParametersCommandFormat< PT >::validate ( const ParametersType ) const
inline

Does nothing.

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