Namespaces
	command_interest

	detail

	dns

	encoding

	ethernet

	exception

	io

	literals

	lp
	Contains classes and functions related to NDNLPv2.

	mgmt

	name

	net

	nfd

	random

	scheduler

	security

	signed_interest

	time

	time_literals

	tlv
	Contains constants and low-level functions related to the NDN packet format.

	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	ConfigFile
	System configuration file for NDN platform. More...

class	Data
	Represents a Data packet. More...

class	Face
	Provide a communication channel with local or remote NDN forwarder. More...

class	FaceUri
	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. More...

class	InterestFilterHandle
	Handle for a registered Interest filter. More...

class	KeyLocator

class	KeyParams
	Base class for key parameters. More...

class	Link
	Represents a `LinkObject` TLV element. 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
	An output stream that writes to a Buffer. More...

class	ostream_joiner

class	PacketBase
	Base class to allow simple management of packet tags. 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	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	TcpTransport
	A transport using TCP socket. More...

class	Transport
	Provides a "TLV-oriented" delivery service. More...

class	UnixTransport
	A transport using Unix stream socket. More...

class	WireDecodable
	A concept check for TLV abstraction with a `wireDecode(Block)` method and constructible from Block. More...

class	WireEncodable
	A concept check for TLV abstraction with a `wireEncode()` method. More...

class	WireEncodableWithEncodingBuffer
	A concept check for TLV abstraction with a `wireEncode(EncodingBuffer)` method. More...

Typedefs
typedef SimpleSymmetricKeyParams< detail::AesKeyParamsInfo >	AesKeyParams
	AesKeyParams carries parameters for AES key. More...

using	BufferPtr = shared_ptr< Buffer >

using	CanonizeProviders = boost::mpl::vector< UdpCanonizeProvider , TcpCanonizeProvider , EtherCanonizeProvider , DevCanonizeProvider , UdpDevCanonizeProvider * >

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

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 SimplePublicKeyParams< detail::EcKeyParamsInfo >	EcKeyParams
	EcKeyParams carries parameters for EC key. More...

typedef SimpleSymmetricKeyParams< detail::HmacKeyParamsInfo >	HmacKeyParams
	HmacKeyParams carries parameters for HMAC key. More...

typedef function< void(const InterestFilter &, const Interest &)>	InterestCallback
	Callback invoked when an incoming Interest matches the specified InterestFilter. More...

typedef function< void(const Interest &, const lp::Nack &)>	NackCallback
	Callback invoked when a Nack is received in response to an expressed Interest. More...

using	PartialName = Name
	Represents an arbitrary sequence of name components. More...

using	Regex = RegexTopMatcher

typedef function< void(const Name &, const std::string &)>	RegisterPrefixFailureCallback
	Callback invoked when registerPrefix or setInterestFilter command fails. More...

typedef function< void(const Name &)>	RegisterPrefixSuccessCallback
	Callback invoked when registerPrefix or setInterestFilter command succeeds. More...

typedef SimplePublicKeyParams< detail::RsaKeyParamsInfo >	RsaKeyParams
	RsaKeyParams carries parameters for RSA key. More...

using	ScopedInterestFilterHandle = detail::ScopedCancelHandle< InterestFilterHandle >
	Scoped handle for a registered Interest filter. 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...

typedef function< void(const Interest &)>	TimeoutCallback
	Callback invoked when an expressed Interest times out. More...

typedef function< void(const std::string &)>	UnregisterPrefixFailureCallback
	Callback invoked when unregistering a prefix fails. More...

typedef function< void()>	UnregisterPrefixSuccessCallback
	Callback invoked when unregistering a prefix succeeds. More...

Enumerations
enum class	BlockCipherAlgorithm { NONE , AES_CBC }

enum class	CipherOperator { DECRYPT , ENCRYPT }

enum class	DigestAlgorithm { NONE = 0 , SHA224 , SHA256 , SHA384 , SHA512 , BLAKE2B_512 , BLAKE2S_256 , SHA3_224 , SHA3_256 , SHA3_384 , SHA3_512 }

enum class	KeyIdType { USER_SPECIFIED = 0 , SHA256 = 1 , RANDOM = 2 }
	The type of KeyId component in a key name. More...

enum class	KeyType { NONE = 0 , RSA , EC , AES , HMAC }
	The type of a cryptographic key. More...

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

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

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

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

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

std::string	escape (const std::string &str)
	Percent-encode a string. More...

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

shared_ptr< Buffer >	fromHex (const std::string &hexString)
	Convert a hex string to a raw byte buffer. More...

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...

template size_t	Interest ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const

template size_t	Interest ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const

template size_t	KeyLocator ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const

template size_t	KeyLocator ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const

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)

template size_t	MetaInfo ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const

template size_t	MetaInfo ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const

template size_t	Name ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const

template size_t	Name ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const

bool	operator!= (const Block &lhs, const Block &rhs) noexcept

bool	operator!= (const Data &lhs, const Data &rhs)

bool	operator!= (const PrefixAnnouncement &lhs, const PrefixAnnouncement &rhs)

bool	operator!= (const SignatureInfo &lhs, const SignatureInfo &rhs)

Block	operator""_block (const char *input, std::size_t len)
	Construct a Block from hexadecimal `input`. More...

constexpr time::duration< long double, time::days::period >	operator""_day (long double days)

constexpr time::days	operator""_day (unsigned long long days)

constexpr time::duration< long double, time::days::period >	operator""_days (long double days)

constexpr time::days	operator""_days (unsigned long long days)

constexpr time::duration< long double, time::hours::period >	operator""_h (long double hrs)

constexpr time::hours	operator""_h (unsigned long long hrs)

constexpr time::duration< long double, time::minutes::period >	operator""_min (long double mins)

constexpr time::minutes	operator""_min (unsigned long long mins)

constexpr time::duration< long double, time::milliseconds::period >	operator""_ms (long double msecs)

constexpr time::milliseconds	operator""_ms (unsigned long long msecs)

constexpr time::duration< long double, time::nanoseconds::period >	operator""_ns (long double nsecs)

constexpr time::nanoseconds	operator""_ns (unsigned long long nsecs)

constexpr time::duration< long double, time::seconds::period >	operator""_s (long double secs)

constexpr time::seconds	operator""_s (unsigned long long secs)

constexpr time::duration< long double, time::microseconds::period >	operator""_us (long double usecs)

constexpr time::microseconds	operator""_us (unsigned long long usecs)

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

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

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

std::ostream &	operator<< (std::ostream &os, const Data &data)

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

std::ostream &	operator<< (std::ostream &os, const Interest &interest)

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

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

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

std::ostream &	operator<< (std::ostream &os, const PrefixAnnouncement &pa)
	Print prefix announcement to a stream. More...

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

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

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

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

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

bool	operator== (const Block &lhs, const Block &rhs) noexcept
	Compare whether two Blocks have the same TLV-TYPE, TLV-LENGTH, and TLV-VALUE. More...

bool	operator== (const Data &lhs, const Data &rhs)

bool	operator== (const PrefixAnnouncement &lhs, const PrefixAnnouncement &rhs)
	Test whether two prefix announcements have the same name, expiration period, and validity period. More...

bool	operator== (const SignatureInfo &lhs, const SignatureInfo &rhs)

std::istream &	operator>> (std::istream &is, Name &name)
	Parse URI from stream as Name. 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...

void	printHex (std::ostream &os, uint64_t num, bool wantUpperCase=false)
	Output the hex representation of `num` to the output stream `os`. More...

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

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

template<typename T >
constexpr std::underlying_type_t< T >	to_underlying (T val) noexcept

std::string	toHex (span< const uint8_t > buffer, bool wantUpperCase=true)
	Return a string containing the hex representation of the bytes in `buffer`. More...

constexpr char	toHexChar (unsigned int n, bool wantUpperCase=true) noexcept
	Convert (the least significant nibble of) `n` to the corresponding hex character. More...

std::string	unescape (const std::string &str)
	Decode a percent-encoded string. More...

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

Variables
const time::milliseconds	DEFAULT_FRESHNESS_PERIOD {0}
	Default value of `FreshnessPeriod`. More...

const time::milliseconds	DEFAULT_INTEREST_LIFETIME = 4_s
	Default value of `InterestLifetime`. More...

const size_t	MAX_KEY_DIGEST_OCTETS_TO_SHOW = 8

const size_t	MAX_NDN_PACKET_SIZE = 8800
	Practical size limit of a network-layer packet. More...

const size_t	MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE

Typedef Documentation

◆ AesKeyParams

typedef SimpleSymmetricKeyParams<detail::AesKeyParamsInfo> ndn::AesKeyParams

AesKeyParams carries parameters for AES key.

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

◆ BufferPtr

using ndn::BufferPtr = typedef shared_ptr<Buffer>

Definition at line 138 of file buffer.hpp.

◆ CanonizeProviders

using ndn::CanonizeProviders = typedef boost::mpl::vector<UdpCanonizeProvider*, TcpCanonizeProvider*, EtherCanonizeProvider*, DevCanonizeProvider*, UdpDevCanonizeProvider*>

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

◆ CanonizeProviderTable

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

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

◆ 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.

◆ EcKeyParams

typedef SimplePublicKeyParams<detail::EcKeyParamsInfo> ndn::EcKeyParams

EcKeyParams carries parameters for EC key.

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

◆ HmacKeyParams

typedef SimpleSymmetricKeyParams<detail::HmacKeyParamsInfo> ndn::HmacKeyParams

HmacKeyParams carries parameters for HMAC key.

Definition at line 309 of file key-params.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.

◆ 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.

◆ PartialName

using ndn::PartialName = typedef Name

Represents an arbitrary sequence of name components.

Definition at line 37 of file name.hpp.

◆ Regex

using ndn::Regex = typedef RegexTopMatcher

Definition at line 31 of file regex.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.

◆ RegisterPrefixSuccessCallback

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

Callback invoked when registerPrefix or setInterestFilter command succeeds.

Definition at line 70 of file face.hpp.

◆ RsaKeyParams

typedef SimplePublicKeyParams<detail::RsaKeyParamsInfo> ndn::RsaKeyParams

RsaKeyParams carries parameters for RSA key.

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

◆ ScopedInterestFilterHandle

using ndn::ScopedInterestFilterHandle = typedef detail::ScopedCancelHandle<InterestFilterHandle>

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 588 of file face.hpp.

◆ ScopedPendingInterestHandle

using ndn::ScopedPendingInterestHandle = typedef detail::ScopedCancelHandle<PendingInterestHandle>

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 513 of file face.hpp.

◆ ScopedRegisteredPrefixHandle

using ndn::ScopedRegisteredPrefixHandle = typedef detail::ScopedCancelHandle<RegisteredPrefixHandle>

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 556 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.

◆ UnregisterPrefixFailureCallback

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

Callback invoked when unregistering a prefix fails.

Definition at line 85 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.

Enumeration Type Documentation

◆ BlockCipherAlgorithm

enum ndn::BlockCipherAlgorithm

strong

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.

◆ 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.

◆ 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.

Function Documentation

◆ 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.

◆ clamp() [1/2]

template<typename T >

constexpr const T& ndn::clamp	(	const T &	v,
		const T &	lo,
		const T &	hi
	)

constexpr

Definition at line 109 of file backports.hpp.

◆ clamp() [2/2]

template<typename T , typename Compare >

constexpr const T& ndn::clamp	(	const T &	v,
		const T &	lo,
		const T &	hi,
		Compare	comp
	)

constexpr

Definition at line 101 of file backports.hpp.

◆ 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

◆ escape() [1/2]

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

Percent-encode a string.

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"

ndn::escape

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

Percent-encode a string.

Definition: string-helper.cpp:76

See also: RFC 3986 section 2

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

◆ escape() [2/2]

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

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

◆ fromHex()

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

Convert a hex string to a raw byte buffer.

Parameters

hexString Sequence of pairs of hex numbers (lower and upper case can be mixed) without any whitespace separators (e.g., "48656C6C6F2C20776F726C6421")

Exceptions

StringHelperError Input string is invalid

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

◆ fromHexChar()

constexpr int ndn::fromHexChar ( char c )

constexprnoexcept

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

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

◆ Interest ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::Interest ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer & ) const

◆ Interest ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::Interest ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator & ) const

◆ KeyLocator ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::KeyLocator ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer & ) const

◆ KeyLocator ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::KeyLocator ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator & ) const

◆ 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

Definition at line 117 of file ostream-joiner.hpp.

◆ MetaInfo ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::MetaInfo ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer & ) const

◆ MetaInfo ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::MetaInfo ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator & ) const

◆ Name ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::Name ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer & ) const

◆ Name ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::Name ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator & ) const

◆ operator!=() [1/4]

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

inlinenoexcept

Definition at line 541 of file block.hpp.

◆ operator!=() [2/4]

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

inline

Definition at line 364 of file data.hpp.

◆ operator!=() [3/4]

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

inline

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

◆ operator!=() [4/4]

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

inline

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

◆ operator""_block()

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

Construct a Block from hexadecimal input.

Parameters

input	a string containing hexadecimal bytes and comments. 0-9 and upper-case A-F are input; all other characters are comments.
len	length of `input`.

Exceptions

std::invalid_argument	input is empty or has an odd number of hexadecimal digits.
tlv::Error	`input` 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.

◆ operator<<() [1/15]

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

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

◆ operator<<() [2/15]

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

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

◆ operator<<() [3/15]

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 491 of file block.cpp.

◆ operator<<() [4/15]

std::ostream & ndn::operator<<	(	std::ostream &	os,
		const Data &	data
	)

Definition at line 373 of file data.cpp.

◆ operator<<() [5/15]

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

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

◆ operator<<() [6/15]

std::ostream & ndn::operator<<	(	std::ostream &	os,
		const Interest &	interest
	)

Definition at line 752 of file interest.cpp.

◆ operator<<() [7/15]

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

Definition at line 65 of file interest-filter.cpp.

◆ operator<<() [8/15]

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

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

◆ operator<<() [9/15]

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

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

◆ operator<<() [10/15]

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 137 of file prefix-announcement.cpp.

◆ operator<<() [11/15]

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

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

◆ operator<<() [12/15]

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

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

◆ operator<<() [13/15]

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

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

◆ operator<<() [14/15]

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

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

◆ operator<<() [15/15]

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

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

◆ operator==() [1/4]

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

noexcept

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

Definition at line 483 of file block.cpp.

◆ operator==() [2/4]

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

Definition at line 364 of file data.cpp.

◆ 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.

◆ operator==() [4/4]

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

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

◆ 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.

◆ printHex() [1/2]

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

os	Output stream
buffer	Range of bytes to print in hexadecimal format
wantUpperCase	if 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.

◆ printHex() [2/2]

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

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

Parameters

os	Output stream
num	Number to print in hexadecimal format
wantUpperCase	if 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.

◆ 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

◆ to_underlying()

template<typename T >

constexpr std::underlying_type_t<T> ndn::to_underlying ( T val )

constexprnoexcept

Definition at line 125 of file backports.hpp.

◆ toHex()

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

buffer	Range of bytes to convert to hexadecimal format
wantUpperCase	if 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.

◆ toHexChar()

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

constexprnoexcept

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

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

◆ unescape() [1/2]

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

Decode a percent-encoded string.

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"

ndn::unescape

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

Decode a percent-encoded string.

Definition: string-helper.cpp:105

See also: RFC 3986 section 2

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

◆ unescape() [2/2]

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

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

Variable Documentation

◆ DEFAULT_FRESHNESS_PERIOD

const time::milliseconds ndn::DEFAULT_FRESHNESS_PERIOD {0}

Default value of FreshnessPeriod.

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

◆ DEFAULT_INTEREST_LIFETIME

const time::milliseconds ndn::DEFAULT_INTEREST_LIFETIME = 4_s

Default value of InterestLifetime.

Definition at line 43 of file interest.hpp.

◆ 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.

◆ MAX_NDN_PACKET_SIZE

const size_t ndn::MAX_NDN_PACKET_SIZE = 8800

Practical size limit of a network-layer packet.

If a packet is longer than this size, library and application MAY drop it.

Definition at line 41 of file tlv.hpp.

◆ 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.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.8.1 documentation

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ AesKeyParams

◆ BufferPtr

◆ CanonizeProviders

◆ CanonizeProviderTable

◆ ConstBufferPtr

◆ DataCallback

◆ EcKeyParams

◆ HmacKeyParams

◆ InterestCallback

◆ NackCallback

◆ PartialName

◆ Regex

◆ RegisterPrefixFailureCallback

◆ RegisterPrefixSuccessCallback

◆ RsaKeyParams

◆ ScopedInterestFilterHandle

◆ ScopedPendingInterestHandle

◆ ScopedRegisteredPrefixHandle

◆ TimeoutCallback

◆ UnregisterPrefixFailureCallback

◆ UnregisterPrefixSuccessCallback

Enumeration Type Documentation

◆ BlockCipherAlgorithm

◆ CipherOperator

◆ DigestAlgorithm

◆ KeyIdType

◆ KeyType

Function Documentation

◆ boost_test_print_type()

◆ clamp() [1/2]

◆ clamp() [2/2]

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

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

◆ escape() [1/2]

◆ escape() [2/2]

◆ fromHex()

◆ fromHexChar()

◆ Interest ::wireEncode<::ndn::encoding::EncoderTag >()

◆ Interest ::wireEncode<::ndn::encoding::EstimatorTag >()

◆ KeyLocator ::wireEncode<::ndn::encoding::EncoderTag >()

◆ KeyLocator ::wireEncode<::ndn::encoding::EstimatorTag >()

◆ make_ostream_joiner()

◆ MetaInfo ::wireEncode<::ndn::encoding::EncoderTag >()

◆ MetaInfo ::wireEncode<::ndn::encoding::EstimatorTag >()

◆ Name ::wireEncode<::ndn::encoding::EncoderTag >()

◆ Name ::wireEncode<::ndn::encoding::EstimatorTag >()

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ operator""_block()

◆ operator<<() [1/15]

◆ operator<<() [2/15]

◆ operator<<() [3/15]

◆ operator<<() [4/15]

◆ operator<<() [5/15]

◆ operator<<() [6/15]

◆ operator<<() [7/15]

◆ operator<<() [8/15]

◆ operator<<() [9/15]

◆ operator<<() [10/15]

◆ operator<<() [11/15]

◆ operator<<() [12/15]

◆ operator<<() [13/15]

◆ operator<<() [14/15]

◆ operator<<() [15/15]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ operator>>()

◆ printHex() [1/2]