ndn::name Namespace Reference

Classes
class	Component
	Represents a name component. More...

Enumerations
enum	: uint8_t {   SEGMENT_MARKER = 0x00 ,   SEGMENT_OFFSET_MARKER = 0xFB ,   VERSION_MARKER = 0xFD ,   TIMESTAMP_MARKER = 0xFC ,   SEQUENCE_NUMBER_MARKER = 0xFE }
	Name component markers defined in Naming Conventions revision 1 (obsolete). More...
enum class	Convention {   MARKER = 1 << 0 ,   TYPED = 1 << 1 ,   EITHER = MARKER | TYPED }
	Identify a style of NDN Naming Conventions. More...
enum class	UriFormat {   CANONICAL ,   ALTERNATE ,   ENV_OR_CANONICAL ,   ENV_OR_ALTERNATE ,   DEFAULT = ENV_OR_ALTERNATE }
	Format used for the URI representation of a name. More...

Functions
template size_t	Component ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
template size_t	Component ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
Convention	getConventionDecoding () noexcept
	Return which Naming Conventions style(s) to accept while decoding. More...
Convention	getConventionEncoding () noexcept
	Return which Naming Conventions style to use while encoding. More...
void	setConventionDecoding (Convention convention)
	Set which Naming Conventions style(s) to accept while decoding. More...
void	setConventionEncoding (Convention convention)
	Set which Naming Conventions style to use while encoding. More...

Enumeration Type Documentation

anonymous enum

anonymous enum : uint8_t

Name component markers defined in Naming Conventions revision 1 (obsolete).

See also

https://named-data.net/publications/techreports/ndn-tr-22-ndn-memo-naming-conventions/

Enumerator
SEGMENT_MARKER
SEGMENT_OFFSET_MARKER
VERSION_MARKER
TIMESTAMP_MARKER
SEQUENCE_NUMBER_MARKER

Definition at line 62 of file name-component.hpp.

Convention

enum ndn::name::Convention

strong

Identify a style of NDN Naming Conventions.

See also

https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/

Enumerator
MARKER	Component markers (revision 1)
TYPED	Typed name components (revision 3)
EITHER

Definition at line 52 of file name-component.hpp.

UriFormat

enum ndn::name::UriFormat

strong

Format used for the URI representation of a name.

See also

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

Enumerator
CANONICAL	Always use <type-number>=<percent-encoded-value> format.
ALTERNATE	Always prefer the alternate format when available.
ENV_OR_CANONICAL	Same as UriFormat::CANONICAL, unless NDN_NAME_ALT_URI environment variable is set to '1'.
ENV_OR_ALTERNATE	Same as UriFormat::ALTERNATE, unless NDN_NAME_ALT_URI environment variable is set to '0'.
DEFAULT	Use the library's default format; currently equivalent to UriFormat::ENV_OR_ALTERNATE.

Definition at line 35 of file name-component.hpp.

Function Documentation

Component ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::name::Component ::wireEncode<::ndn::encoding::EncoderTag >

(

::ndn::EncodingBuffer &

)

const

Component ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::name::Component ::wireEncode<::ndn::encoding::EstimatorTag >

(

::ndn::EncodingEstimator &

)

const

getConventionDecoding()

Convention ndn::name::getConventionDecoding ( )

noexcept

Return which Naming Conventions style(s) to accept while decoding.

The current library default is Convention::EITHER, but this may change in the future.

Definition at line 60 of file name-component.cpp.

getConventionEncoding()

Convention ndn::name::getConventionEncoding ( )

noexcept

Return which Naming Conventions style to use while encoding.

The library default is Convention::TYPED.

Definition at line 41 of file name-component.cpp.

setConventionDecoding()

void ndn::name::setConventionDecoding

(

Convention

convention

)

Set which Naming Conventions style(s) to accept while decoding.

Parameters

convention

Convention::MARKER or Convention::TYPED accepts the specified style only; Convention::EITHER accepts either.

Definition at line 66 of file name-component.cpp.

setConventionEncoding()

void ndn::name::setConventionEncoding

(

Convention

convention

)

Set which Naming Conventions style to use while encoding.

Parameters

convention

Either Convention::MARKER or Convention::TYPED.

Definition at line 47 of file name-component.cpp.