NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options Class Reference

Options that control the behavior of GenericLinkService. More...

#include <generic-link-service.hpp>

Collaboration diagram for nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options:

Public Member Functions

 Options () noexcept

Public Attributes

bool allowLocalFields = false
 enables encoding of IncomingFaceId, and decoding of NextHopFaceId and CachePolicy More...
bool allowFragmentation = false
 enables fragmentation More...
LpFragmenter::Options fragmenterOptions
 options for fragmentation More...
bool allowReassembly = false
 enables reassembly More...
LpReassembler::Options reassemblerOptions
 options for reassembly More...
LpReliability::Options reliabilityOptions
 options for reliability More...
bool allowCongestionMarking = false
 enables send queue congestion detection and marking More...
time::nanoseconds baseCongestionMarkingInterval = 100_ms
 starting value for congestion marking interval More...
size_t defaultCongestionThreshold = 65536
 default congestion threshold in bytes More...
bool allowSelfLearning = true
 enables self-learning forwarding support More...
ssize_t overrideMtu = std::numeric_limits<ssize_t>::max()
 overrides MTU provided by Transport More...
std::function< std::shared_ptr< ndn::lp::GeoTag >)> enableGeoTags
 Enable encoding and decoding of GeoTags. More...

Detailed Description

Options that control the behavior of GenericLinkService.

Definition at line 104 of file generic-link-service.hpp.

Constructor & Destructor Documentation

◆ Options()

nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::Options ( )

Definition at line 107 of file generic-link-service.hpp.

Member Data Documentation

◆ allowLocalFields

bool nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::allowLocalFields = false

enables encoding of IncomingFaceId, and decoding of NextHopFaceId and CachePolicy

Definition at line 114 of file generic-link-service.hpp.

◆ allowFragmentation

bool nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::allowFragmentation = false

enables fragmentation

Definition at line 118 of file generic-link-service.hpp.

◆ fragmenterOptions

LpFragmenter::Options nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::fragmenterOptions

options for fragmentation

Definition at line 122 of file generic-link-service.hpp.

◆ allowReassembly

bool nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::allowReassembly = false

enables reassembly

Definition at line 126 of file generic-link-service.hpp.

◆ reassemblerOptions

LpReassembler::Options nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::reassemblerOptions

options for reassembly

Definition at line 130 of file generic-link-service.hpp.

◆ reliabilityOptions

LpReliability::Options nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::reliabilityOptions

options for reliability

Definition at line 134 of file generic-link-service.hpp.

◆ allowCongestionMarking

bool nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::allowCongestionMarking = false

enables send queue congestion detection and marking

Definition at line 138 of file generic-link-service.hpp.

◆ baseCongestionMarkingInterval

time::nanoseconds nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::baseCongestionMarkingInterval = 100_ms

starting value for congestion marking interval

Packets are marked if the queue size stays above THRESHOLD for at least one INTERVAL.

The default value (100 ms) is taken from RFC 8289 (CoDel).

Definition at line 146 of file generic-link-service.hpp.

◆ defaultCongestionThreshold

size_t nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::defaultCongestionThreshold = 65536

default congestion threshold in bytes

Packets are marked if the queue size stays above THRESHOLD for at least one INTERVAL.

The default value (64 KiB) works well for a queue capacity of 200 KiB.

Definition at line 154 of file generic-link-service.hpp.

◆ allowSelfLearning

bool nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::allowSelfLearning = true

enables self-learning forwarding support

Definition at line 158 of file generic-link-service.hpp.

◆ overrideMtu

ssize_t nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::overrideMtu = std::numeric_limits<ssize_t>::max()

overrides MTU provided by Transport

This MTU value will be used instead of the MTU provided by the transport if it is less than the transport MTU. However, it will not be utilized when the transport MTU is unlimited.

Acceptable values for the override MTU are values >= MIN_MTU, which can be validated before being set with canOverrideMtuTo().

Definition at line 168 of file generic-link-service.hpp.

◆ enableGeoTags

std::function<std::shared_ptr<ndn::lp::GeoTag>)> nfd::face::NFD_FINAL_UNLESS_WITH_TESTS::Options::enableGeoTags

Enable encoding and decoding of GeoTags.

To enable, set value of enableGeoTags option to a function that generates shared_ptr<GeoTag>

Definition at line 174 of file generic-link-service.hpp.

The documentation for this class was generated from the following file: