represents parameters in a ControlCommand request or response
More...
#include <ndn-cxx/mgmt/nfd/control-parameters.hpp>
represents parameters in a ControlCommand request or response
- See also
- https://redmine.named-data.net/projects/nfd/wiki/ControlCommand#ControlParameters
This type is copyable because it's an abstraction of a TLV type.
Definition at line 81 of file control-parameters.hpp.
| ndn::nfd::ControlParameters::ControlParameters |
( |
| ) |
|
| ndn::nfd::ControlParameters::ControlParameters |
( |
const Block & |
block | ) |
|
|
explicit |
| time::nanoseconds ndn::nfd::ControlParameters::getBaseCongestionMarkingInterval |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getCapacity |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getCost |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getCount |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getDefaultCongestionThreshold |
( |
| ) |
const |
|
inline |
| const time::milliseconds& ndn::nfd::ControlParameters::getExpirationPeriod |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getFaceId |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::getFlagBit |
( |
size_t |
bit | ) |
const |
- Returns
- bit at a position in Flags
- Parameters
-
| bit | bit position within range [0, 64) (least significant bit is 0) |
Definition at line 258 of file control-parameters.cpp.
| uint64_t ndn::nfd::ControlParameters::getFlags |
( |
| ) |
const |
|
inline |
| const std::string& ndn::nfd::ControlParameters::getLocalUri |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getMask |
( |
| ) |
const |
|
inline |
| uint64_t ndn::nfd::ControlParameters::getMtu |
( |
| ) |
const |
|
inline |
get MTU (measured in bytes)
This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.
Definition at line 571 of file control-parameters.hpp.
| const Name& ndn::nfd::ControlParameters::getName |
( |
| ) |
const |
|
inline |
| RouteOrigin ndn::nfd::ControlParameters::getOrigin |
( |
| ) |
const |
|
inline |
| const std::vector<bool>& ndn::nfd::ControlParameters::getPresentFields |
( |
| ) |
const |
|
inline |
| const Name& ndn::nfd::ControlParameters::getStrategy |
( |
| ) |
const |
|
inline |
| const std::string& ndn::nfd::ControlParameters::getUri |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasBaseCongestionMarkingInterval |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasCapacity |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasCost |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasCount |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasDefaultCongestionThreshold |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasExpirationPeriod |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasFaceId |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasFacePersistency |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasFlagBit |
( |
size_t |
bit | ) |
const |
- Returns
- whether bit is enabled in Mask
- Parameters
-
| bit | bit position within range [0, 64) (least significant bit is 0) |
Definition at line 244 of file control-parameters.cpp.
| bool ndn::nfd::ControlParameters::hasFlags |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasLocalUri |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasMask |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasMtu |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasName |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasOrigin |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasStrategy |
( |
| ) |
const |
|
inline |
| bool ndn::nfd::ControlParameters::hasUri |
( |
| ) |
const |
|
inline |
| ControlParameters& ndn::nfd::ControlParameters::setBaseCongestionMarkingInterval |
( |
time::nanoseconds |
interval | ) |
|
|
inline |
| ControlParameters& ndn::nfd::ControlParameters::setDefaultCongestionThreshold |
( |
uint64_t |
threshold | ) |
|
|
inline |
| ControlParameters& ndn::nfd::ControlParameters::setExpirationPeriod |
( |
const time::milliseconds & |
expirationPeriod | ) |
|
|
inline |
| ControlParameters & ndn::nfd::ControlParameters::setFlagBit |
( |
size_t |
bit, |
|
|
bool |
value, |
|
|
bool |
wantMask = true |
|
) |
| |
set a bit in Flags
- Parameters
-
| bit | bit position within range [0, 64) (least significant bit is 0) |
| value | new value in Flags |
| wantMask | if true, enable the bit in Mask |
Definition at line 272 of file control-parameters.cpp.
| ControlParameters& ndn::nfd::ControlParameters::setLocalUri |
( |
const std::string & |
localUri | ) |
|
|
inline |
set MTU (measured in bytes)
This value is capped at MAX_NDN_PACKET_SIZE, even if the MTU of the face is unlimited.
Definition at line 582 of file control-parameters.hpp.
| ControlParameters& ndn::nfd::ControlParameters::unsetBaseCongestionMarkingInterval |
( |
| ) |
|
|
inline |
disable a bit in Mask
- Parameters
-
| bit | bit position within range [0, 64) (least significant bit is 0) |
- Postcondition
- If all bits are disabled, Flags and Mask fields are deleted.
Definition at line 297 of file control-parameters.cpp.
| void ndn::nfd::ControlParameters::wireDecode |
( |
const Block & |
wire | ) |
|
|
finalvirtual |
template<encoding::Tag TAG>
| size_t ndn::nfd::ControlParameters::wireEncode |
( |
EncodingImpl< TAG > & |
encoder | ) |
const |
| Block ndn::nfd::ControlParameters::wireEncode |
( |
| ) |
const |
|
finalvirtual |
Inheritance diagram for ndn::nfd::ControlParameters:
1.8.11 
