ndn::name Namespace Reference

Namespaces
	detail

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

Enumerations
enum	UriFormat { UriFormat::DEFAULT, UriFormat::CANONICAL, UriFormat::ALTERNATE }
	Identify a format of URI representation. More...
enum	Convention { Convention::MARKER = 1 << 0, Convention::TYPED = 1 << 1, Convention::EITHER = MARKER | TYPED }
	Identify a style of NDN Naming Conventions. More...
enum	: uint8_t {   SEGMENT_MARKER = 0x00, SEGMENT_OFFSET_MARKER = 0xFB, VERSION_MARKER = 0xFD, TIMESTAMP_MARKER = 0xFC,   SEQUENCE_NUMBER_MARKER = 0xFE }
	Markers in Naming Conventions rev1. More...

Functions
Convention	getConventionEncoding ()
	Return which Naming Conventions style to use while encoding. More...
void	setConventionEncoding (Convention convention)
	Set which Naming Conventions style to use while encoding. More...
Convention	getConventionDecoding ()
	Return which Naming Conventions style(s) to accept while decoding. More...
void	setConventionDecoding (Convention convention)
	Set which Naming Conventions style(s) to accept while decoding. More...
static bool	canDecodeMarkerConvention ()
static bool	canDecodeTypedConvention ()
static bool	chooseAltUri (UriFormat format)
static Component	parseUriEscapedValue (uint32_t type, const char *input, size_t len)
	NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (Component)
	NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (Component)

Variables
	WireEncodable< Component >
	WireEncodableWithEncodingBuffer< Component >
	WireDecodable< Component >
static Convention	g_conventionEncoding = Convention::MARKER
static Convention	g_conventionDecoding = Convention::EITHER

Enumeration Type Documentation

UriFormat

enum ndn::name::UriFormat

strong

Identify a format of URI representation.

Enumerator
DEFAULT	ALTERNATE, unless NDN_NAME_ALT_URI environment variable is set to '0'.
CANONICAL	always use <type-number>=<percent-encoded-value> format
ALTERNATE	prefer alternate format when available

Definition at line 35 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-2-ndn-memo-naming-conventions/

Enumerator
MARKER	component markers (revision 1)
TYPED	typed name components (revision 2)
EITHER

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

anonymous enum

anonymous enum : uint8_t

Markers in Naming Conventions rev1.

Enumerator
SEGMENT_MARKER
SEGMENT_OFFSET_MARKER
VERSION_MARKER
TIMESTAMP_MARKER
SEQUENCE_NUMBER_MARKER

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

Function Documentation

getConventionEncoding()

Convention ndn::name::getConventionEncoding

(

)

Return which Naming Conventions style to use while encoding.

The current library default is Convention::MARKER, but this will change in the future.

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

References g_conventionEncoding.

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 53 of file name-component.cpp.

References g_conventionEncoding, MARKER, NDN_THROW, and TYPED.

getConventionDecoding()

Convention ndn::name::getConventionDecoding

(

)

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

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

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

References g_conventionDecoding.

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 72 of file name-component.cpp.

References g_conventionDecoding.

canDecodeMarkerConvention()

static bool ndn::name::canDecodeMarkerConvention ( )

static

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

References g_conventionDecoding, MARKER, and ndn::to_underlying().

Referenced by ndn::name::Component::isByteOffset(), ndn::name::Component::isSegment(), ndn::name::Component::isSequenceNumber(), ndn::name::Component::isTimestamp(), ndn::name::Component::isVersion(), ndn::name::Component::toByteOffset(), ndn::name::Component::toSegment(), ndn::name::Component::toSequenceNumber(), ndn::name::Component::toTimestamp(), and ndn::name::Component::toVersion().

canDecodeTypedConvention()

static bool ndn::name::canDecodeTypedConvention ( )

static

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

References g_conventionDecoding, ndn::to_underlying(), and TYPED.

Referenced by ndn::name::Component::isByteOffset(), ndn::name::Component::isSegment(), ndn::name::Component::isSequenceNumber(), ndn::name::Component::isTimestamp(), ndn::name::Component::isVersion(), ndn::name::Component::toByteOffset(), ndn::name::Component::toSegment(), ndn::name::Component::toSequenceNumber(), ndn::name::Component::toTimestamp(), and ndn::name::Component::toVersion().

chooseAltUri()

static bool ndn::name::chooseAltUri ( UriFormat  format )

static

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

References ALTERNATE, and DEFAULT.

Referenced by ndn::name::Component::toUri().

parseUriEscapedValue()

static Component ndn::name::parseUriEscapedValue ( uint32_t  type, const char *  input, size_t  len  )

static

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

References NDN_THROW, and ndn::unescape().

Referenced by ndn::name::Component::fromEscapedString().

NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS()

ndn::name::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS

(

Component

)

NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS()

ndn::name::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS

(

Component

)

Variable Documentation

WireEncodable< Component >

ndn::name::WireEncodable< Component >

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

WireEncodableWithEncodingBuffer< Component >

ndn::name::WireEncodableWithEncodingBuffer< Component >

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

WireDecodable< Component >

ndn::name::WireDecodable< Component >

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

g_conventionEncoding

Convention ndn::name::g_conventionEncoding = Convention::MARKER

static

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

Referenced by ndn::name::Component::fromByteOffset(), ndn::name::Component::fromSegment(), ndn::name::Component::fromSequenceNumber(), ndn::name::Component::fromTimestamp(), ndn::name::Component::fromVersion(), getConventionEncoding(), and setConventionEncoding().

g_conventionDecoding

Convention ndn::name::g_conventionDecoding = Convention::EITHER

static

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

Referenced by canDecodeMarkerConvention(), canDecodeTypedConvention(), getConventionDecoding(), and setConventionDecoding().