Namespaces
	command_interest

	detail

	dns

	encoding

	ethernet

	io

	ip

	literals

	lp

	mgmt

	name

	net

	nfd

	random

	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	bad_optional_access

class	Block
	Represents a TLV element of 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...

struct	Delegation
	represents a delegation More...

class	DelegationList
	represents a list of Delegations More...

class	DigestSha256
	Represents a signature of DigestSha256 type. More...

class	Exclude
	Represents Exclude selector in NDN Interest. More...

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

struct	in_place_t

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	KeyLocator

class	KeyParams
	Base class of key parameters. More...

class	Link
	represents a Link object More...

class	MetaInfo
	An 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	nullopt_t

class	OBufferStream
	implements an output stream that constructs `ndn::Buffer` More...

class	optional

class	ostream_joiner

class	PacketBase
	base class to allow simple management of packet tags More...

class	RegexBackrefManager

class	RegexBackrefMatcher

class	RegexComponentMatcher

class	RegexComponentSetMatcher

class	RegexMatcher

class	RegexPatternListMatcher

class	RegexPseudoMatcher

class	RegexRepeatMatcher

class	RegexTopMatcher

class	Selectors
	Abstraction implementing Interest selectors. More...

class	Signature
	Holds SignatureInfo and SignatureValue in a Data packet. More...

class	SignatureInfo
	Represents a SignatureInfo TLV element. More...

class	SignatureSha256WithEcdsa
	Represents a signature of Sha256WithEcdsa type. More...

class	SignatureSha256WithRsa
	Represents a signature of Sha256WithRsa type. 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	StreamTransportImpl
	implementation detail of a Boost.Asio-based stream-oriented transport More...

class	StreamTransportWithResolverImpl
	implementation detail of a Boost.Asio-based stream-oriented transport with resolver support 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 TLV-block delivery service More...

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

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
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 expressed Interest gets satisfied with a Data packet. More...

typedef SimplePublicKeyParams< detail::EcKeyParamsInfo >	EcKeyParams
	EcKeyParams carries parameters for EC key. More...

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

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

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

typedef RegexTopMatcher	Regex

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

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

typedef function< void(const std::string &)>	UnregisterPrefixFailureCallback
	Callback invoked when unregisterPrefix or unsetInterestFilter command fails. More...

typedef function< void()>	UnregisterPrefixSuccessCallback
	Callback invoked when unregisterPrefix or unsetInterestFilter command succeeds. More...

Enumerations
enum	AclType { AclType::NONE, AclType::PUBLIC, AclType::PRIVATE }

enum	BlockCipherAlgorithm { BlockCipherAlgorithm::NONE, BlockCipherAlgorithm::AES_CBC }

enum	CipherOperator { CipherOperator::DECRYPT = 0, CipherOperator::ENCRYPT = 1 }

enum	DigestAlgorithm { DigestAlgorithm::NONE = 0, DigestAlgorithm::SHA224 = 2, DigestAlgorithm::SHA256 = 1, DigestAlgorithm::SHA384 = 3, DigestAlgorithm::SHA512 = 4, DigestAlgorithm::BLAKE2B_512 = 10, DigestAlgorithm::BLAKE2S_256 = 11 }

enum	KeyClass { KeyClass::NONE, KeyClass::PUBLIC, KeyClass::PRIVATE, KeyClass::SYMMETRIC }

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 = 1, KeyType::EC = 2, KeyType::AES = 128 }
	The type of a cryptographic key. More...

Functions
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 size_t	Data::wireEncode< encoding::EncoderTag > (EncodingBuffer &, bool) const

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

template size_t	DelegationList::wireEncode< encoding::EncoderTag > (EncodingBuffer &, uint32_t) const

template size_t	DelegationList::wireEncode< encoding::EstimatorTag > (EncodingEstimator &, uint32_t) const

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

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

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

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

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

shared_ptr< Buffer >	fromHex (const std::string &hexString)
	Convert the hex string to 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...

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

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 T >
constexpr optional< typename std::decay< T >::type >	make_optional (T &&value)

template<typename T , typename... Args>
constexpr optional< T >	make_optional (Args &&...args)

template<typename CharT , typename Traits , typename DelimT >
ostream_joiner< typename std::decay< DelimT >::type, CharT, Traits >	make_ostream_joiner (std::basic_ostream< CharT, Traits > &os, DelimT &&delimiter)

template<typename T , typename... Args>
unique_ptr< T >	make_unique (Args &&...args)

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 Delegation &lhs, const Delegation &rhs)

template<typename T >
constexpr bool	operator!= (const optional< T > &lhs, const optional< T > &rhs)

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

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

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

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

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

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

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

bool	operator< (const Delegation &lhs, const Delegation &rhs)

template<typename T >
constexpr bool	operator< (const optional< T > &lhs, const optional< T > &rhs)

bool	operator< (const Name &lhs, const Name &rhs)

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

std::ostream &	operator<< (std::ostream &os, const AsHex &hex)

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

std::ostream &	operator<< (std::ostream &os, const Delegation &del)

std::ostream &	operator<< (std::ostream &os, KeyClass keyClass)

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

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

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

std::ostream &	operator<< (std::ostream &os, const Exclude::Range &range)

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

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

std::ostream &	operator<< (std::ostream &os, AclType aclType)

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

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

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

std::ostream &	operator<< (std::ostream &os, const DelegationList &dl)

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

std::ostream &	operator<< (std::ostream &os, const Name &name)
	Print URI representation of a name. More...

std::ostream &	operator<< (std::ostream &os, const Exclude &exclude)

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

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

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

bool	operator<= (const Delegation &lhs, const Delegation &rhs)

template<typename T >
constexpr bool	operator<= (const optional< T > &lhs, const optional< T > &rhs)

bool	operator<= (const Name &lhs, const Name &rhs)

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

bool	operator== (const Exclude::ExcludeComponent &a, const Exclude::ExcludeComponent &b)

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

template<typename T >
constexpr bool	operator== (const optional< T > &lhs, const optional< T > &rhs)

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

bool	operator== (const DelegationList &lhs, const DelegationList &rhs)
	compare whether two DelegationLists are equal More...

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

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

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

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

bool	operator> (const Exclude::ExcludeComponent &a, const Exclude::ExcludeComponent &b)

bool	operator> (const Delegation &lhs, const Delegation &rhs)

template<typename T >
constexpr bool	operator> (const optional< T > &lhs, const optional< T > &rhs)

bool	operator> (const Name &lhs, const Name &rhs)

bool	operator>= (const Delegation &lhs, const Delegation &rhs)

template<typename T >
constexpr bool	operator>= (const optional< T > &lhs, const optional< T > &rhs)

bool	operator>= (const Name &lhs, const Name &rhs)

std::istream &	operator>> (std::istream &is, Name &name)
	Parse URI from stream as Name. More...

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

void	printHex (std::ostream &os, const Buffer &buffer, bool wantUpperCase=true)
	Output the hex representation of the bytes in `buffer` to the output stream `os`. More...

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

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

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

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

template<typename V >
std::string	to_string (const V &v)

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

std::string	toHex (const Buffer &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
static const uint32_t	AES_KEY_SIZES [] = {128, 192, 256}

static constexpr size_t	BOOST_REGEXP_MARK_COUNT_CORRECTION

const int	DEFAULT_CHILD_SELECTOR = 0

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

const time::milliseconds	DEFAULT_INTEREST_LIFETIME = 4_s
	default value for InterestLifetime More...

static const uint32_t	DEFAULT_RSA_KEY_SIZE = 2048

static const uint32_t	EC_KEY_SIZES [] = {256, 384}

constexpr in_place_t	in_place {}

const size_t	MAX_NDN_PACKET_SIZE = 8800
	practical limit of network layer packet size More...

const size_t	MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE

static const uint32_t	MIN_RSA_KEY_SIZE = 1024

constexpr nullopt_t	nullopt {0}

Detailed Description

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.

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.

Author: Alexander Afanasyev http://lasr.cs.ucla.edu/afanasyev/index.html

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.

Author: Eric Newberry enewb.nosp@m.erry.nosp@m.@emai.nosp@m.l.ar.nosp@m.izona.nosp@m..edu

Louis, Beijing Institute of Technology, The University of Memphis.