NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn Namespace Reference

Copyright (c) 2011-2015 Regents of the University of California. More...

Namespaces

 command_interest
 
 detail
 
 encoding
 
 ethernet
 
 exception
 
 io
 
 literals
 
 lp
 
 mgmt
 
 name
 
 net
 
 nfd
 
 random
 
 scheduler
 
 security
 
 signed_interest
 
 time
 
 tlv
 Namespace defining NDN Packet Format related constants and procedures.
 
 util
 

Classes

class  AsHex
 Helper class to convert a number to hexadecimal format, for use with stream insertion operators. More...
 
class  Block
 Represents a TLV element of the NDN packet format. More...
 
class  Buffer
 General-purpose automatically managed/resized buffer. More...
 
class  CanonizeProvider
 a CanonizeProvider provides FaceUri canonization functionality for a group of schemes More...
 
class  CanonizeProviderTableInitializer
 
class  ConfigFile
 System configuration file for NDN platform. More...
 
class  Data
 Represents a Data packet. More...
 
class  DevCanonizeProvider
 
class  DummyIoService
 
class  EtherCanonizeProvider
 
class  Face
 Provide a communication channel with local or remote NDN forwarder. More...
 
class  FaceUri
 represents the underlying protocol and address used by a Face More...
 
class  InMemoryStorage
 Represents in-memory storage. More...
 
class  InMemoryStorageEntry
 Represents an in-memory storage entry. More...
 
class  InMemoryStorageFifo
 Provides in-memory storage employing First-In-First-Out (FIFO) replacement policy. More...
 
class  InMemoryStorageLfu
 Provides an in-memory storage with Least Frequently Used (LFU) replacement policy. More...
 
class  InMemoryStorageLru
 Provides in-memory storage employing Least Recently Used (LRU) replacement policy. More...
 
class  InMemoryStoragePersistent
 Provides application cache with persistent storage, of which no replacement policy will be employed. More...
 
class  Interest
 Represents an Interest packet. More...
 
class  InterestFilter
 declares the set of Interests a producer can serve, which starts with a name prefix, plus an optional regular expression More...
 
class  InterestFilterHandle
 Handle for a registered Interest filter. More...
 
class  InterestFilterRecord
 Associates an InterestFilter with an Interest callback. More...
 
class  IpHostCanonizeProvider
 
class  KeyLocator
 
class  KeyParams
 Base class for key parameters. More...
 
class  Link
 represents a Link object More...
 
class  MetadataObject
 Class for RDR-style metadata encoding/decoding. More...
 
class  MetaInfo
 A MetaInfo holds the meta info which is signed inside the data packet. More...
 
class  Name
 Represents an absolute name. More...
 
class  NotificationStreamItem
 concept check for an item in a Notification Stream More...
 
class  OBufferStream
 implements an output stream that constructs ndn::Buffer More...
 
class  ostream_joiner
 
class  PacketBase
 base class to allow simple management of packet tags More...
 
class  PendingInterest
 Stores a pending Interest and associated callbacks. More...
 
class  PendingInterestHandle
 Handle for a pending Interest. More...
 
class  PrefixAnnouncement
 A prefix announcement object that represents an application's intent of registering a prefix toward itself. More...
 
class  RegexBackrefManager
 
class  RegexBackrefMatcher
 
class  RegexComponentMatcher
 
class  RegexComponentSetMatcher
 
class  RegexMatcher
 
class  RegexPatternListMatcher
 
class  RegexPseudoMatcher
 
class  RegexRepeatMatcher
 
class  RegexTopMatcher
 
class  RegisteredPrefix
 Stores information about a prefix registered in an NDN forwarder. More...
 
class  RegisteredPrefixHandle
 Handle for a registered prefix. More...
 
class  SignatureInfo
 Represents a SignatureInfo or InterestSignatureInfo TLV element. More...
 
class  SimplePublicKeyParams
 SimplePublicKeyParams is a template for public keys with only one parameter: size. More...
 
class  SimpleSymmetricKeyParams
 SimpleSymmetricKeyParams is a template for symmetric keys with only one parameter: size. More...
 
class  SimpleTag
 provides a tag type for simple types More...
 
class  StatusDatasetItem
 concept check for an item in a Status Dataset More...
 
class  StringHelperError
 
class  Tag
 Base class for packet tags that can hold any arbitrary information. More...
 
class  TagHost
 Base class to store tag information (e.g., inside Interest and Data packets) More...
 
class  TcpCanonizeProvider
 
class  Transport
 Provides TLV-block delivery service. More...
 
class  UdpCanonizeProvider
 
class  UdpDevCanonizeProvider
 
class  WireDecodable
 a concept check for TLV abstraction with .wireDecode method and constructible from Block More...
 
class  WireEncodable
 a concept check for TLV abstraction with .wireEncode method More...
 
class  WireEncodableWithEncodingBuffer
 a concept check for TLV abstraction with .wireEncode method More...
 

Typedefs

using BufferPtr = shared_ptr< Buffer >
 
using ConstBufferPtr = shared_ptr< const Buffer >
 
typedef function< void(const Interest &, const Data &)> DataCallback
 Callback invoked when an expressed Interest is satisfied by a Data packet. More...
 
typedef function< void(const Interest &, const lp::Nack &)> NackCallback
 Callback invoked when a Nack is received in response to an expressed Interest. More...
 
typedef function< void(const Interest &)> TimeoutCallback
 Callback invoked when an expressed Interest times out. More...
 
typedef function< void(const InterestFilter &, const Interest &)> InterestCallback
 Callback invoked when an incoming Interest matches the specified InterestFilter. More...
 
typedef function< void(const Name &)> RegisterPrefixSuccessCallback
 Callback invoked when registerPrefix or setInterestFilter command succeeds. More...
 
typedef function< void(const Name &, const std::string &)> RegisterPrefixFailureCallback
 Callback invoked when registerPrefix or setInterestFilter command fails. More...
 
typedef function< void()> UnregisterPrefixSuccessCallback
 Callback invoked when unregistering a prefix succeeds. More...
 
typedef function< void(const std::string &)> UnregisterPrefixFailureCallback
 Callback invoked when unregistering a prefix fails. More...
 
using ScopedPendingInterestHandle = detail::ScopedCancelHandle< PendingInterestHandle >
 Scoped handle for a pending Interest. More...
 
using ScopedRegisteredPrefixHandle = detail::ScopedCancelHandle< RegisteredPrefixHandle >
 Scoped handle for a registered prefix. More...
 
using ScopedInterestFilterHandle = detail::ScopedCancelHandle< InterestFilterHandle >
 Scoped handle for a registered Interest filter. More...
 
using PartialName = Name
 Represents an arbitrary sequence of name components. More...
 
using CanonizeProviders = boost::mpl::vector< UdpCanonizeProvider *, TcpCanonizeProvider *, EtherCanonizeProvider *, DevCanonizeProvider *, UdpDevCanonizeProvider * >
 
using CanonizeProviderTable = std::map< std::string, shared_ptr< CanonizeProvider > >
 
typedef SimplePublicKeyParams< detail::RsaKeyParamsInfoRsaKeyParams
 RsaKeyParams carries parameters for RSA key. More...
 
typedef SimplePublicKeyParams< detail::EcKeyParamsInfoEcKeyParams
 EcKeyParams carries parameters for EC key. More...
 
typedef SimpleSymmetricKeyParams< detail::AesKeyParamsInfoAesKeyParams
 AesKeyParams carries parameters for AES key. More...
 
typedef SimpleSymmetricKeyParams< detail::HmacKeyParamsInfoHmacKeyParams
 HmacKeyParams carries parameters for HMAC key. More...
 
using Regex = RegexTopMatcher
 

Enumerations

enum  PendingInterestOrigin { PendingInterestOrigin::APP, PendingInterestOrigin::FORWARDER }
 Indicates where a pending Interest came from. More...
 
enum  KeyIdType { KeyIdType::USER_SPECIFIED = 0, KeyIdType::SHA256 = 1, KeyIdType::RANDOM = 2 }
 The type of KeyId component in a key name. More...
 
enum  KeyType {
  KeyType::NONE = 0, KeyType::RSA, KeyType::EC, KeyType::AES,
  KeyType::HMAC
}
 The type of a cryptographic key. More...
 
enum  DigestAlgorithm {
  DigestAlgorithm::NONE = 0, DigestAlgorithm::SHA224, DigestAlgorithm::SHA256, DigestAlgorithm::SHA384,
  DigestAlgorithm::SHA512, DigestAlgorithm::BLAKE2B_512, DigestAlgorithm::BLAKE2S_256, DigestAlgorithm::SHA3_224,
  DigestAlgorithm::SHA3_256, DigestAlgorithm::SHA3_384, DigestAlgorithm::SHA3_512
}
 
enum  BlockCipherAlgorithm { BlockCipherAlgorithm::NONE, BlockCipherAlgorithm::AES_CBC }
 
enum  CipherOperator { CipherOperator::DECRYPT, CipherOperator::ENCRYPT }
 

Functions

template size_t Data::wireEncode< encoding::EncoderTag > (EncodingBuffer &, bool) const
 
template size_t Data::wireEncode< encoding::EstimatorTag > (EncodingEstimator &, bool) const
 
bool operator== (const Data &lhs, const Data &rhs)
 
std::ostream & operator<< (std::ostream &os, const Data &data)
 
bool operator!= (const Data &lhs, const Data &rhs)
 
bool operator== (const Block &lhs, const Block &rhs)
 Compare whether two Blocks have same TLV-TYPE, TLV-LENGTH, and TLV-VALUE. More...
 
std::ostream & operator<< (std::ostream &os, const Block &block)
 
Block operator""_block (const char *input, std::size_t len)
 Construct a Block from hexadecimal input. More...
 
bool operator!= (const Block &lhs, const Block &rhs)
 
std::ostream & boost_test_print_type (std::ostream &os, const Buffer &buf)
 
template<typename NetPkt >
static void extractLpLocalFields (NetPkt &netPacket, const lp::Packet &lpPacket)
 extract local fields from NDNLPv2 packet and tag onto a network layer packet More...
 
template<typename Field , typename Tag , typename Packet >
void addFieldFromTag (lp::Packet &lpPacket, const Packet &packet)
 
template<typename Tag , typename Field , typename Packet >
void addTagFromField (Packet &packet, const lp::Packet &lpPacket)
 
std::ostream & operator<< (std::ostream &os, PendingInterestOrigin origin)
 
std::ostream & operator<< (std::ostream &os, const InterestFilter &filter)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (Interest)
 
static auto generateNonce ()
 
std::ostream & operator<< (std::ostream &os, const Interest &interest)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (Interest)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (KeyLocator)
 
std::ostream & operator<< (std::ostream &os, const KeyLocator &keyLocator)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (KeyLocator)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (MetaInfo)
 
std::ostream & operator<< (std::ostream &os, const MetaInfo &info)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (MetaInfo)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (Name)
 
std::istream & operator>> (std::istream &is, Name &name)
 Parse URI from stream as Name. More...
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (Name)
 
std::ostream & operator<< (std::ostream &os, const FaceUri &uri)
 
static const CanonizeProvidergetCanonizeProvider (const std::string &scheme)
 
bool operator== (const PrefixAnnouncement &lhs, const PrefixAnnouncement &rhs)
 Test whether two prefix announcements have the same name, expiration period, and validity period. More...
 
std::ostream & operator<< (std::ostream &os, const PrefixAnnouncement &pa)
 Print prefix announcement to a stream. More...
 
bool operator!= (const PrefixAnnouncement &lhs, const PrefixAnnouncement &rhs)
 
std::ostream & operator<< (std::ostream &os, KeyIdType keyIdType)
 
std::ostream & operator<< (std::ostream &os, KeyType keyType)
 
std::ostream & operator<< (std::ostream &os, DigestAlgorithm algorithm)
 
std::ostream & operator<< (std::ostream &os, BlockCipherAlgorithm algorithm)
 
std::ostream & operator<< (std::ostream &os, CipherOperator op)
 
template size_t SignatureInfo::wireEncode< encoding::EncoderTag > (EncodingBuffer &, SignatureInfo::Type) const
 
template size_t SignatureInfo::wireEncode< encoding::EstimatorTag > (EncodingEstimator &, SignatureInfo::Type) const
 
bool operator== (const SignatureInfo &lhs, const SignatureInfo &rhs)
 
std::ostream & operator<< (std::ostream &os, const SignatureInfo &info)
 
bool operator!= (const SignatureInfo &lhs, const SignatureInfo &rhs)
 
template<typename T >
std::string to_string (const T &val)
 
template<typename T , typename Compare >
constexpr const T & clamp (const T &v, const T &lo, const T &hi, Compare comp)
 
template<typename T >
constexpr const T & clamp (const T &v, const T &lo, const T &hi)
 
template<typename T >
NDN_CXX_NODISCARD constexpr std::underlying_type_t< T > to_underlying (T val) noexcept
 
template<typename CharT , typename Traits , typename DelimT >
ostream_joiner< std::decay_t< DelimT >, CharT, Traits > make_ostream_joiner (std::basic_ostream< CharT, Traits > &os, DelimT &&delimiter)
 
std::ostream & operator<< (std::ostream &os, const RegexMatcher &rm)
 
void printHex (std::ostream &os, uint64_t num, bool wantUpperCase=false)
 Output the hex representation of num to the output stream os. More...
 
void printHex (std::ostream &os, span< const uint8_t > buffer, bool wantUpperCase=true)
 Output the hex representation of the bytes in buffer to the output stream os. More...
 
std::string toHex (span< const uint8_t > buffer, bool wantUpperCase=true)
 Return a string containing the hex representation of the bytes in buffer. More...
 
shared_ptr< BufferfromHex (const std::string &hexString)
 Convert the hex string to buffer. More...
 
std::string escape (const std::string &str)
 Percent-encode a string. More...
 
void escape (std::ostream &os, const char *str, size_t len)
 
std::string unescape (const std::string &str)
 Decode a percent-encoded string. More...
 
void unescape (std::ostream &os, const char *str, size_t len)
 
void printHex (std::ostream &os, const uint8_t *buffer, size_t length, bool wantUpperCase=true)
 Output the hex representation of the bytes in buffer to the output stream os. More...
 
NDN_CXX_NODISCARD std::string toHex (const uint8_t *buffer, size_t length, bool wantUpperCase=true)
 Return a string containing the hex representation of the bytes in buffer. More...
 
NDN_CXX_NODISCARD constexpr char toHexChar (unsigned int n, bool wantUpperCase=true) noexcept
 Convert (the least significant nibble of) n to the corresponding hex character. More...
 
NDN_CXX_NODISCARD constexpr int fromHexChar (char c) noexcept
 Convert the hex character c to an integer in [0, 15], or -1 if it's not a hex character. More...
 

Variables

 WireEncodable< Data >
 
 WireEncodableWithEncodingBuffer< Data >
 
 WireDecodable< Data >
 
const size_t MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE
 
const size_t MAX_NDN_PACKET_SIZE = 8800
 Practical size limit of a network-layer packet. More...
 
 WireEncodable< Interest >
 
 WireEncodableWithEncodingBuffer< Interest >
 
 WireDecodable< Interest >
 
const time::milliseconds DEFAULT_INTEREST_LIFETIME = 4_s
 default value for InterestLifetime More...
 
 WireEncodable< KeyLocator >
 
 WireEncodableWithEncodingBuffer< KeyLocator >
 
 WireDecodable< KeyLocator >
 
const size_t MAX_KEY_DIGEST_OCTETS_TO_SHOW = 8
 
 WireEncodable< Link >
 
 WireEncodableWithEncodingBuffer< Link >
 
 WireDecodable< Link >
 
 WireEncodable< MetaInfo >
 
 WireEncodableWithEncodingBuffer< MetaInfo >
 
 WireDecodable< MetaInfo >
 
const time::milliseconds DEFAULT_FRESHNESS_PERIOD = time::milliseconds::zero()
 
 WireEncodable< Name >
 
 WireEncodableWithEncodingBuffer< Name >
 
 WireDecodable< Name >
 
static constexpr uint8_t SHA256_OF_EMPTY_STRING []
 
 WireEncodable< SignatureInfo >
 
 WireEncodableWithEncodingBuffer< SignatureInfo >
 
 WireDecodable< SignatureInfo >
 

Detailed Description

Copyright (c) 2011-2015 Regents of the University of California.

Copyright (c) 2013-2019 Regents of the University of California.

This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and contributors.

ndnSIM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ndnSIM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ndnSIM, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Typedef Documentation

◆ BufferPtr

using ndn::BufferPtr = typedef shared_ptr<Buffer>

Definition at line 138 of file buffer.hpp.

◆ ConstBufferPtr

using ndn::ConstBufferPtr = typedef shared_ptr<const Buffer>

Definition at line 139 of file buffer.hpp.

◆ DataCallback

typedef function<void(const Interest&, const Data&)> ndn::DataCallback

Callback invoked when an expressed Interest is satisfied by a Data packet.

Definition at line 50 of file face.hpp.

◆ NackCallback

typedef function<void(const Interest&, const lp::Nack&)> ndn::NackCallback

Callback invoked when a Nack is received in response to an expressed Interest.

Definition at line 55 of file face.hpp.

◆ TimeoutCallback

typedef function<void(const Interest&)> ndn::TimeoutCallback

Callback invoked when an expressed Interest times out.

Definition at line 60 of file face.hpp.

◆ InterestCallback

typedef function<void(const InterestFilter&, const Interest&)> ndn::InterestCallback

Callback invoked when an incoming Interest matches the specified InterestFilter.

Definition at line 65 of file face.hpp.

◆ RegisterPrefixSuccessCallback

typedef function<void(const Name&)> ndn::RegisterPrefixSuccessCallback

Callback invoked when registerPrefix or setInterestFilter command succeeds.

Definition at line 70 of file face.hpp.

◆ RegisterPrefixFailureCallback

typedef function<void(const Name&, const std::string&)> ndn::RegisterPrefixFailureCallback

Callback invoked when registerPrefix or setInterestFilter command fails.

Definition at line 75 of file face.hpp.

◆ UnregisterPrefixSuccessCallback

typedef function<void()> ndn::UnregisterPrefixSuccessCallback

Callback invoked when unregistering a prefix succeeds.

Definition at line 80 of file face.hpp.

◆ UnregisterPrefixFailureCallback

typedef function<void(const std::string&)> ndn::UnregisterPrefixFailureCallback

Callback invoked when unregistering a prefix fails.

Definition at line 85 of file face.hpp.

◆ ScopedPendingInterestHandle

Scoped handle for a pending Interest.

Upon destruction of this handle, the pending Interest is canceled automatically. Most commonly, the application keeps a ScopedPendingInterestHandle as a class member field, so that it can cleanup its pending Interest when the class instance is destructed.

{
ScopedPendingInterestHandle hdl = face.expressInterest(interest, satisfyCb, nackCb, timeoutCb);
} // hdl goes out of scope, canceling the pending Interest

Definition at line 460 of file face.hpp.

◆ ScopedRegisteredPrefixHandle

Scoped handle for a registered prefix.

Upon destruction of this handle, the prefix is unregistered automatically. Most commonly, the application keeps a ScopedRegisteredPrefixHandle as a class member field, so that it can cleanup its prefix registration when the class instance is destructed. The application will not be notified whether the unregistration was successful.

{
ScopedRegisteredPrefixHandle hdl = face.registerPrefix(prefix, onSuccess, onFailure);
} // hdl goes out of scope, unregistering the prefix

Definition at line 503 of file face.hpp.

◆ ScopedInterestFilterHandle

Scoped handle for a registered Interest filter.

Upon destruction of this handle, the Interest filter is canceled automatically. Most commonly, the application keeps a ScopedInterestFilterHandle as a class member field, so that it can cleanup its Interest filter when the class instance is destructed.

{
ScopedInterestFilterHandle hdl = face.setInterestFilter(prefix, onInterest);
} // hdl goes out of scope, unsetting the Interest filter

Definition at line 535 of file face.hpp.

◆ PartialName

using ndn::PartialName = typedef Name

Represents an arbitrary sequence of name components.

Definition at line 36 of file name.hpp.

◆ CanonizeProviders

◆ CanonizeProviderTable

using ndn::CanonizeProviderTable = typedef std::map<std::string, shared_ptr<CanonizeProvider> >

Definition at line 571 of file face-uri.cpp.

◆ RsaKeyParams

RsaKeyParams carries parameters for RSA key.

Definition at line 199 of file key-params.hpp.

◆ EcKeyParams

EcKeyParams carries parameters for EC key.

Definition at line 202 of file key-params.hpp.

◆ AesKeyParams

AesKeyParams carries parameters for AES key.

Definition at line 306 of file key-params.hpp.

◆ HmacKeyParams

HmacKeyParams carries parameters for HMAC key.

Definition at line 309 of file key-params.hpp.

◆ Regex

using ndn::Regex = typedef RegexTopMatcher

Definition at line 31 of file regex.hpp.

Enumeration Type Documentation

◆ PendingInterestOrigin

Indicates where a pending Interest came from.

Enumerator
APP 

Interest was received from this app via Face::expressInterest API.

FORWARDER 

Interest was received from the forwarder via Transport.

Definition at line 37 of file pending-interest.hpp.

◆ KeyIdType

enum ndn::KeyIdType
strong

The type of KeyId component in a key name.

Enumerator
USER_SPECIFIED 

User-specified key id.

It is the user's responsibility to ensure the uniqueness of the key names.

SHA256 

Use the SHA-256 hash of the public key as key id.

This KeyIdType guarantees the uniqueness of the key names.

RANDOM 

Use a 64-bit random number as key id.

This KeyIdType provides uniqueness (with very high probability) of the key names.

Definition at line 68 of file security-common.hpp.

◆ KeyType

enum ndn::KeyType
strong

The type of a cryptographic key.

Enumerator
NONE 

Unknown or unsupported key type.

RSA 

RSA key, supports sign/verify and encrypt/decrypt operations.

EC 

Elliptic Curve key (e.g. for ECDSA), supports sign/verify operations.

AES 

AES key, supports encrypt/decrypt operations.

HMAC 

HMAC key, supports sign/verify operations.

Definition at line 95 of file security-common.hpp.

◆ DigestAlgorithm

enum ndn::DigestAlgorithm
strong
Enumerator
NONE 
SHA224 
SHA256 
SHA384 
SHA512 
BLAKE2B_512 
BLAKE2S_256 
SHA3_224 
SHA3_256 
SHA3_384 
SHA3_512 

Definition at line 106 of file security-common.hpp.

◆ BlockCipherAlgorithm

Enumerator
NONE 
AES_CBC 

Definition at line 123 of file security-common.hpp.

◆ CipherOperator

enum ndn::CipherOperator
strong
Enumerator
DECRYPT 
ENCRYPT 

Definition at line 131 of file security-common.hpp.

Function Documentation

◆ Data::wireEncode< encoding::EncoderTag >()

template size_t ndn::Data::wireEncode< encoding::EncoderTag > ( EncodingBuffer &  ,
bool   
) const

◆ Data::wireEncode< encoding::EstimatorTag >()

template size_t ndn::Data::wireEncode< encoding::EstimatorTag > ( EncodingEstimator &  ,
bool   
) const

◆ operator==() [1/4]

◆ operator<<() [1/16]

◆ operator!=() [1/4]

bool ndn::operator!= ( const Data lhs,
const Data rhs 
)
inline

Definition at line 352 of file data.hpp.

◆ operator==() [2/4]

bool ndn::operator== ( const Block lhs,
const Block rhs 
)

Compare whether two Blocks have same TLV-TYPE, TLV-LENGTH, and TLV-VALUE.

Definition at line 483 of file block.cpp.

References ndn::Block::type(), ndn::Block::value(), and ndn::Block::value_size().

◆ operator<<() [2/16]

std::ostream& ndn::operator<< ( std::ostream &  os,
const Block block 
)

Default-constructed Block is printed as: [invalid]. Zero-length Block is printed as: TT[empty], where TT is TLV-TYPE in decimal. Non-zero-length Block on which parse() has not been called is printed as: TT[LL]=VVVV, where LL is TLV-LENGTH in decimal, and VVVV is TLV-VALUE in hexadecimal. Block on which parse() has been called is printed as: TT[LL]={SUB,SUB}, where each SUB is a sub-element printed using this format.

Definition at line 492 of file block.cpp.

References ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::Block::isValid(), ndn::Block::m_elements, make_ostream_joiner(), printHex(), ndn::Block::type(), ndn::Block::value_bytes(), and ndn::Block::value_size().

◆ operator""_block()

Block ndn::operator""_block ( const char *  input,
std::size_t  len 
)

Construct a Block from hexadecimal input.

Parameters
inputa string containing hexadecimal bytes and comments. 0-9 and upper-case A-F are input; all other characters are comments.
lenlength of input.
Exceptions
std::invalid_argumentinput is empty or has an odd number of hexadecimal digits.
tlv::Errorinput cannot be parsed into a valid Block.

Example:

Block nameBlock = "0706 080141 080142"_block;
Block nackBlock = "FD032005 reason(no-route)=FD03210196"_block;

Definition at line 519 of file block.cpp.

References ndn::Block::Block(), ndn::OBufferStream::buf(), ndn::Block::end(), ndn::security::transform::hexDecode(), NDN_THROW, and ndn::security::transform::streamSink().

◆ operator!=() [2/4]

bool ndn::operator!= ( const Block lhs,
const Block rhs 
)
inline

Definition at line 532 of file block.hpp.

◆ boost_test_print_type()

std::ostream& ndn::boost_test_print_type ( std::ostream &  os,
const Buffer buf 
)

Definition at line 28 of file buffer.cpp.

References printHex().

Referenced by ndn::Buffer::get().

◆ extractLpLocalFields()

template<typename NetPkt >
static void ndn::extractLpLocalFields ( NetPkt &  netPacket,
const lp::Packet lpPacket 
)
static

◆ addFieldFromTag()

template<typename Field , typename Tag , typename Packet >
void ndn::addFieldFromTag ( lp::Packet lpPacket,
const Packet &  packet 
)

Definition at line 32 of file lp-field-tag.hpp.

References ndn::lp::Packet::add().

◆ addTagFromField()

template<typename Tag , typename Field , typename Packet >
void ndn::addTagFromField ( Packet &  packet,
const lp::Packet lpPacket 
)

Definition at line 42 of file lp-field-tag.hpp.

References ndn::lp::Packet::get(), and ndn::lp::Packet::has().

◆ operator<<() [3/16]

std::ostream& ndn::operator<< ( std::ostream &  os,
PendingInterestOrigin  origin 
)

Definition at line 44 of file pending-interest.hpp.

References APP, FORWARDER, and NDN_CXX_UNREACHABLE.

◆ operator<<() [4/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const InterestFilter filter 
)

◆ NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS() [1/4]

ndn::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( Interest  )

◆ generateNonce()

static auto ndn::generateNonce ( )
static

Definition at line 393 of file interest.cpp.

References ndn::random::generateWord32().

Referenced by ndn::Interest::getNonce(), and ndn::Interest::refreshNonce().

◆ operator<<() [5/16]

◆ NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS() [1/4]

ndn::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( Interest  )

◆ NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS() [2/4]

ndn::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( KeyLocator  )

◆ operator<<() [6/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const KeyLocator keyLocator 
)

◆ NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS() [2/4]

ndn::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( KeyLocator  )

◆ NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS() [3/4]

ndn::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( MetaInfo  )

◆ operator<<() [7/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const MetaInfo info 
)

◆ NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS() [3/4]

ndn::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( MetaInfo  )

◆ NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS() [4/4]

ndn::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( Name  )

◆ operator>>()

std::istream & ndn::operator>> ( std::istream &  is,
Name name 
)

Parse URI from stream as Name.

See also
https://named-data.net/doc/NDN-packet-spec/0.3/name.html#ndn-uri-scheme

Definition at line 371 of file name.cpp.

References ndn::Name::Name().

◆ NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS() [4/4]

ndn::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( Name  )

◆ operator<<() [8/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const FaceUri uri 
)

Definition at line 197 of file face-uri.cpp.

◆ getCanonizeProvider()

static const CanonizeProvider* ndn::getCanonizeProvider ( const std::string &  scheme)
static

◆ operator==() [3/4]

bool ndn::operator== ( const PrefixAnnouncement lhs,
const PrefixAnnouncement rhs 
)

Test whether two prefix announcements have the same name, expiration period, and validity period.

Definition at line 130 of file prefix-announcement.cpp.

References ndn::PrefixAnnouncement::getAnnouncedName(), ndn::PrefixAnnouncement::getExpiration(), and ndn::PrefixAnnouncement::getValidityPeriod().

◆ operator<<() [9/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const PrefixAnnouncement pa 
)

Print prefix announcement to a stream.

The output is for debugging purposes only. The format may change at any time without notice.

Definition at line 138 of file prefix-announcement.cpp.

References ndn::PrefixAnnouncement::getAnnouncedName(), ndn::PrefixAnnouncement::getExpiration(), and ndn::PrefixAnnouncement::getValidityPeriod().

◆ operator!=() [3/4]

bool ndn::operator!= ( const PrefixAnnouncement lhs,
const PrefixAnnouncement rhs 
)
inline

Definition at line 144 of file prefix-announcement.hpp.

References operator<<().

◆ operator<<() [10/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
KeyIdType  keyIdType 
)

Definition at line 29 of file security-common.cpp.

References RANDOM, SHA256, to_underlying(), and USER_SPECIFIED.

◆ operator<<() [11/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
KeyType  keyType 
)

Definition at line 43 of file security-common.cpp.

References AES, EC, HMAC, NONE, RSA, and to_underlying().

◆ operator<<() [12/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
DigestAlgorithm  algorithm 
)

◆ operator<<() [13/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
BlockCipherAlgorithm  algorithm 
)

Definition at line 91 of file security-common.cpp.

References AES_CBC, NONE, and to_underlying().

◆ operator<<() [14/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
CipherOperator  op 
)

Definition at line 103 of file security-common.cpp.

References DECRYPT, ENCRYPT, and to_underlying().

◆ SignatureInfo::wireEncode< encoding::EncoderTag >()

template size_t ndn::SignatureInfo::wireEncode< encoding::EncoderTag > ( EncodingBuffer &  ,
SignatureInfo::Type   
) const

◆ SignatureInfo::wireEncode< encoding::EstimatorTag >()

template size_t ndn::SignatureInfo::wireEncode< encoding::EstimatorTag > ( EncodingEstimator &  ,
SignatureInfo::Type   
) const

◆ operator==() [4/4]

bool ndn::operator== ( const SignatureInfo lhs,
const SignatureInfo rhs 
)

Definition at line 345 of file signature-info.cpp.

◆ operator<<() [15/16]

◆ operator!=() [4/4]

bool ndn::operator!= ( const SignatureInfo lhs,
const SignatureInfo rhs 
)
inline

Definition at line 252 of file signature-info.hpp.

References info, and ndn::SignatureInfo::operator<<.

◆ to_string()

template<typename T >
std::string ndn::to_string ( const T &  val)

Definition at line 86 of file backports.hpp.

References clamp().

Referenced by nfd::fw::AccessStrategy::AccessStrategy(), ndn::security::detail::CertificateBundleDecoder::append(), nfd::fw::asf::AsfStrategy::AsfStrategy(), ndn::Name::at(), nfd::fw::BestRouteStrategy::BestRouteStrategy(), ndn::security::transform::BlockCipher::BlockCipher(), ndn::security::v2::Certificate::Certificate(), ndn::security::v2::validator_config::Rule::check(), nfd::ethernet::checkFrameHeader(), ndn::detail::RsaKeyParamsInfo::checkKeySize(), ndn::detail::EcKeyParamsInfo::checkKeySize(), ndn::detail::AesKeyParamsInfo::checkKeySize(), ndn::detail::HmacKeyParamsInfo::checkKeySize(), nfd::ConfigFile::checkRange(), nfd::rib::FibUpdater::computeAndSendFibUpdates(), ndn::lp::DecodeHelper< TlvType, EmptyValue >::decode(), ndn::lp::DecodeHelper< TlvType, uint64_t >::decode(), ndn::lp::DecodeHelper< TlvType, std::pair< Buffer::const_iterator, Buffer::const_iterator > >::decode(), ndn::lp::FieldDecl< LOCATION, VALUE, TYPE, REPEATABLE, DECODER_TAG, ENCODER_TAG >::decode(), ndn::security::transform::PrivateKey::decrypt(), nfd::face::EthernetTransport::doClose(), nfd::PrivilegeHelper::drop(), nfd::RibManager::enableLocalFields(), ndn::security::transform::PublicKey::encrypt(), nfd::face::EthernetFactory::EthernetFactory(), ndn::FaceUri::FaceUri(), nfd::FibManager::FibManager(), ndn::name::Component::fromEscapedString(), ndn::FaceUri::fromFd(), ndn::FaceUri::fromUdpDev(), ndn::random::generateSecureBytes(), ndn::Block::get(), ndn::security::v2::Certificate::getExtension(), ndn::net::NetlinkSocket::joinGroup(), nfd::face::EthernetChannel::listen(), ndn::security::v2::validator_config::ValidationPolicyConfig::load(), ndn::io::loadBuffer(), main(), ndn::security::v2::validator_config::Rule::match(), ndn::MetadataObject::MetadataObject(), nfd::fw::MulticastStrategy::MulticastStrategy(), ndn::net::NetlinkSocket::nlmsgTypeToString(), ndn::net::GenlSocket::nlmsgTypeToString(), ndn::net::NetlinkSocket::open(), ndn::util::operator<<(), nfd::strategy_choice::operator<<(), nfd::ConfigFile::parse(), ndn::Block::parse(), ndn::security::v2::parseLocatorUri(), ndn::PrefixAnnouncement::PrefixAnnouncement(), nfd::fw::RandomStrategy::RandomStrategy(), ndn::tlv::readNonNegativeInteger(), ndn::encoding::readNonNegativeIntegerAs(), ndn::tlv::readType(), ndn::io::saveBuffer(), nfd::fw::SelfLearningStrategy::SelfLearningStrategy(), nfd::CommandAuthenticator::setConfigFile(), ndn::KeyLocator::setKeyDigest(), nfd::fw::asf::ProbingModule::setProbingInterval(), nfd::face::UdpFactory::UdpFactory(), ndn::security::v2::Validator::validate(), ndn::name::wantAltUri(), ndn::lp::Packet::wireDecode(), ndn::Link::wireDecode(), ndn::SignatureInfo::wireDecode(), ndn::Data::wireDecode(), ndn::Interest::wireDecode(), ndn::KeyLocator::wireEncode(), and ndn::ConfigFile::~ConfigFile().

◆ clamp() [1/2]

template<typename T , typename Compare >
constexpr const T& ndn::clamp ( const T &  v,
const T &  lo,
const T &  hi,
Compare  comp 
)

◆ clamp() [2/2]

template<typename T >
constexpr const T& ndn::clamp ( const T &  v,
const T &  lo,
const T &  hi 
)

Definition at line 109 of file backports.hpp.

References NDN_CXX_NODISCARD, and to_underlying().

Referenced by to_string().

◆ to_underlying()

◆ make_ostream_joiner()

template<typename CharT , typename Traits , typename DelimT >
ostream_joiner<std::decay_t<DelimT>, CharT, Traits> ndn::make_ostream_joiner ( std::basic_ostream< CharT, Traits > &  os,
DelimT &&  delimiter 
)
inline

◆ operator<<() [16/16]

std::ostream & ndn::operator<< ( std::ostream &  os,
const RegexMatcher rm 
)

Definition at line 75 of file regex-matcher.cpp.

References ndn::RegexMatcher::getExpr().

◆ printHex() [1/3]

void ndn::printHex ( std::ostream &  os,
uint64_t  num,
bool  wantUpperCase = false 
)

Output the hex representation of num to the output stream os.

Parameters
osOutput stream
numNumber to print in hexadecimal format
wantUpperCaseif true, print uppercase hex chars; the default is to use lowercase

The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 34 of file string-helper.cpp.

Referenced by boost_test_print_type(), ndn::lp::operator<<(), ndn::util::operator<<(), operator<<(), printHex(), and toHex().

◆ printHex() [2/3]

void ndn::printHex ( std::ostream &  os,
span< const uint8_t >  buffer,
bool  wantUpperCase = true 
)

Output the hex representation of the bytes in buffer to the output stream os.

Parameters
osOutput stream
bufferRange of bytes to print in hexadecimal format
wantUpperCaseif true (the default) print uppercase hex chars

Each octet of input is always converted to two hex characters (e.g., "00" for octet==0). The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 45 of file string-helper.cpp.

References ndn::security::transform::hexEncode(), and ndn::security::transform::streamSink().

◆ toHex() [1/2]

NDN_CXX_NODISCARD std::string ndn::toHex ( span< const uint8_t >  buffer,
bool  wantUpperCase = true 
)

Return a string containing the hex representation of the bytes in buffer.

Parameters
bufferRange of bytes to convert to hexadecimal format
wantUpperCaseif true (the default) use uppercase hex chars

Each octet of input is always converted to two hex characters (e.g., "00" for octet==0). The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 52 of file string-helper.cpp.

References printHex().

Referenced by toHex(), and ndn::util::Sha256::toString().

◆ fromHex()

shared_ptr< Buffer > ndn::fromHex ( const std::string &  hexString)

Convert the hex string to buffer.

Parameters
hexStringsequence of pairs of hex numbers (lower and upper case can be mixed) without any whitespace separators (e.g., "48656C6C6F2C20776F726C6421")
Exceptions
StringHelperErrorif input is invalid

Definition at line 60 of file string-helper.cpp.

References ndn::OBufferStream::buf(), ndn::security::transform::hexDecode(), NDN_THROW_NESTED, and ndn::security::transform::streamSink().

Referenced by toHex().

◆ escape() [1/2]

NDN_CXX_NODISCARD std::string ndn::escape ( const std::string &  str)

Percent-encode a string.

See also
RFC 3986 section 2

This function will encode all characters that are not one of the following: ALPHA ("a" to "z" and "A" to "Z") / DIGIT (0 to 9) / "-" / "." / "_" / "~"

The hex encoding uses the numbers 0-9 and the uppercase letters A-F.

Examples:

escape("hello world") == "hello%20world"
escape("100%") == "100%25"

Definition at line 76 of file string-helper.cpp.

Referenced by fromHexChar().

◆ escape() [2/2]

void ndn::escape ( std::ostream &  os,
const char *  str,
size_t  len 
)

Definition at line 84 of file string-helper.cpp.

References toHexChar().

◆ unescape() [1/2]

NDN_CXX_NODISCARD std::string ndn::unescape ( const std::string &  str)

Decode a percent-encoded string.

See also
RFC 3986 section 2

When % is not followed by two hex characters, the output is not transformed.

Examples:

unescape("hello%20world") == "hello world"
unescape("hello%20world%FooBar") == "hello world%FooBar"

Definition at line 105 of file string-helper.cpp.

Referenced by fromHexChar(), ndn::IpHostCanonizeProvider< boost::asio::ip::tcp >::IpHostCanonizeProvider(), and ndn::name::parseUriEscapedValue().

◆ unescape() [2/2]

void ndn::unescape ( std::ostream &  os,
const char *  str,
size_t  len 
)

Definition at line 113 of file string-helper.cpp.

References fromHexChar().

◆ printHex() [3/3]

void ndn::printHex ( std::ostream &  os,
const uint8_t *  buffer,
size_t  length,
bool  wantUpperCase = true 
)
inline

Output the hex representation of the bytes in buffer to the output stream os.

Deprecated:
Parameters
osOutput stream
bufferPointer to an array of bytes
lengthSize of the array
wantUpperCaseif true (the default) print uppercase hex chars

Examples:

printHex(std::cout, "Hello, World!"); // outputs "48656C6C6F2C20776F726C6421"
printHex(std::cout, "Hello, World!", false); // outputs "48656c6c6f2c20776f726c6421"

Each octet is always represented as two hex characters ("00" for octet==0). The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 82 of file string-helper.hpp.

References printHex().

◆ toHex() [2/2]

NDN_CXX_NODISCARD std::string ndn::toHex ( const uint8_t *  buffer,
size_t  length,
bool  wantUpperCase = true 
)
inline

Return a string containing the hex representation of the bytes in buffer.

Deprecated:
Parameters
bufferPointer to an array of bytes
lengthSize of the array
wantUpperCaseif true (the default) use uppercase hex chars

Examples:

toHex("Hello, World!") == "48656C6C6F2C20776F726C6421"
toHex("Hello, World!", false) == "48656c6c6f2c20776f726c6421"

Each octet is always represented as two hex characters ("00" for octet==0). The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 151 of file string-helper.hpp.

References fromHex(), NDN_CXX_NODISCARD, and toHex().

◆ toHexChar()

NDN_CXX_NODISCARD constexpr char ndn::toHexChar ( unsigned int  n,
bool  wantUpperCase = true 
)
noexcept

Convert (the least significant nibble of) n to the corresponding hex character.

Definition at line 169 of file string-helper.hpp.

References NDN_CXX_NODISCARD.

Referenced by escape().

◆ fromHexChar()

NDN_CXX_NODISCARD constexpr int ndn::fromHexChar ( char  c)
noexcept

Convert the hex character c to an integer in [0, 15], or -1 if it's not a hex character.

Definition at line 180 of file string-helper.hpp.

References escape(), NDN_CXX_NODISCARD, and unescape().

Referenced by unescape().

Variable Documentation

◆ WireEncodable< Data >

Definition at line 28 of file data.cpp.

◆ WireEncodableWithEncodingBuffer< Data >

Definition at line 29 of file data.cpp.

◆ WireDecodable< Data >

Definition at line 30 of file data.cpp.

◆ MAX_SIZE_OF_BLOCK_FROM_STREAM

const size_t ndn::MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE

Definition at line 40 of file block.cpp.

◆ MAX_NDN_PACKET_SIZE

◆ WireEncodable< Interest >

Definition at line 37 of file interest.cpp.

◆ WireEncodableWithEncodingBuffer< Interest >

◆ WireDecodable< Interest >

Definition at line 39 of file interest.cpp.

◆ DEFAULT_INTEREST_LIFETIME

const unspecified_duration_type ndn::DEFAULT_INTEREST_LIFETIME = 4_s

default value for InterestLifetime

Definition at line 43 of file interest.hpp.

Referenced by operator<<(), ndn::Interest::setAutoCheckParametersDigest(), ndn::Interest::wireDecode(), and ndn::Interest::wireEncode().

◆ WireEncodable< KeyLocator >

Definition at line 31 of file key-locator.cpp.

◆ WireEncodableWithEncodingBuffer< KeyLocator >

◆ WireDecodable< KeyLocator >

Definition at line 33 of file key-locator.cpp.

◆ MAX_KEY_DIGEST_OCTETS_TO_SHOW

const size_t ndn::MAX_KEY_DIGEST_OCTETS_TO_SHOW = 8

Definition at line 37 of file key-locator.cpp.

Referenced by operator<<().

◆ WireEncodable< Link >

Definition at line 27 of file link.cpp.

◆ WireEncodableWithEncodingBuffer< Link >

Definition at line 28 of file link.cpp.

◆ WireDecodable< Link >

Definition at line 29 of file link.cpp.

◆ WireEncodable< MetaInfo >

Definition at line 29 of file meta-info.cpp.

◆ WireEncodableWithEncodingBuffer< MetaInfo >

◆ WireDecodable< MetaInfo >

Definition at line 31 of file meta-info.cpp.

◆ DEFAULT_FRESHNESS_PERIOD

const time::milliseconds ndn::DEFAULT_FRESHNESS_PERIOD = time::milliseconds::zero()

Definition at line 35 of file meta-info.hpp.

Referenced by ndn::MetaInfo::wireDecode(), and ndn::MetaInfo::wireEncode().

◆ WireEncodable< Name >

Definition at line 39 of file name.cpp.

◆ WireEncodableWithEncodingBuffer< Name >

Definition at line 40 of file name.cpp.

◆ WireDecodable< Name >

Definition at line 41 of file name.cpp.

◆ SHA256_OF_EMPTY_STRING

constexpr uint8_t ndn::SHA256_OF_EMPTY_STRING[]
static
Initial value:
= {
0xe3, 0xb0, 0xc4, 0x42, 0x98, 0xfc, 0x1c, 0x14,
0x9a, 0xfb, 0xf4, 0xc8, 0x99, 0x6f, 0xb9, 0x24,
0x27, 0xae, 0x41, 0xe4, 0x64, 0x9b, 0x93, 0x4c,
0xa4, 0x95, 0x99, 0x1b, 0x78, 0x52, 0xb8, 0x55,
}

Definition at line 255 of file name.cpp.

◆ WireEncodable< SignatureInfo >

Definition at line 32 of file signature-info.cpp.

◆ WireEncodableWithEncodingBuffer< SignatureInfo >

◆ WireDecodable< SignatureInfo >

Definition at line 34 of file signature-info.cpp.