ndnph::convention Namespace Reference

Namespaces
namespace	detail

Classes
class	RandomValue
	Indicate that TLV-VALUE should be a random number. More...
class	TimeValue
	Indicate that TLV-VALUE should be a timestamp. More...

Typedefs
using	ImplicitDigest = detail::TypedDigest< TT::ImplicitSha256DigestComponent >
	ImplicitSha256DigestComponent type.
using	ParamsDigest = detail::TypedDigest< TT::ParametersSha256DigestComponent >
	ParametersSha256DigestComponent type.
using	Keyword = detail::TypedString< TT::KeywordNameComponent >
	KeywordNameComponent convention.
using	GenericNumber = detail::TypedNumber< TT::GenericNameComponent >
	GenericNameComponent that contains NNI.
using	Segment = detail::TypedNumber< TT::SegmentNameComponent >
	SegmentNameComponent convention.
using	ByteOffset = detail::TypedNumber< TT::ByteOffsetNameComponent >
	ByteOffsetNameComponent convention.
using	Version = detail::TypedNumber< TT::VersionNameComponent >
	VersionNameComponent convention.
using	Timestamp = detail::TypedNumber< TT::TimestampNameComponent >
	TimestampNameComponent convention.
using	SequenceNum = detail::TypedNumber< TT::SequenceNumNameComponent >
	SequenceNumNameComponent convention.

Typedef Documentation

ByteOffset

using ndnph::convention::ByteOffset = typedef detail::TypedNumber<TT::ByteOffsetNameComponent>

ByteOffsetNameComponent convention.

Supported operations are same as convention::Segment.

GenericNumber

using ndnph::convention::GenericNumber = typedef detail::TypedNumber<TT::GenericNameComponent>

GenericNameComponent that contains NNI.

Supported operations are same as convention::Timestamp.

ImplicitDigest

using ndnph::convention::ImplicitDigest = typedef detail::TypedDigest<TT::ImplicitSha256DigestComponent>

ImplicitSha256DigestComponent type.

Supported operations:

uint8_t digest[NDNPH_SHA256_LEN];
name.append(region, convention::ImplicitDigest(), digest);
bool isDigest = component.is<convention::ImplicitDigest>();
uint8_t* digest2 = component.as<convention::ImplicitDigest>();

Keyword

using ndnph::convention::Keyword = typedef detail::TypedString<TT::KeywordNameComponent>

KeywordNameComponent convention.

Supported operations:

name.append(region, convention::Keyword(), "hello");
bool isKeyword = component.is<convention::Keyword>();
const char* keyword = component.as<convention::Keyword>(region);

`component.as<convention::Keyword>(region)` copies TLV-VALUE and appends NUL. It may return incorrect result if TLV-VALUE contains non-printable characters. It's recommended to use `component.value()` but there's no NUL termination.

ParamsDigest

using ndnph::convention::ParamsDigest = typedef detail::TypedDigest<TT::ParametersSha256DigestComponent>

ParametersSha256DigestComponent type.

Supported operations are same as convention::ImplicitDigest.

Segment

using ndnph::convention::Segment = typedef detail::TypedNumber<TT::SegmentNameComponent>

SegmentNameComponent convention.

Supported operations:

name.append(region, convention::Segment(), 700);
bool isSegment = component.is<convention::Segment>();
uint64_t segment = component.as<convention::Segment>();

SequenceNum

using ndnph::convention::SequenceNum = typedef detail::TypedNumber<TT::SequenceNumNameComponent>

SequenceNumNameComponent convention.

Supported operations are same as convention::Segment.

Timestamp

using ndnph::convention::Timestamp = typedef detail::TypedNumber<TT::TimestampNameComponent>

TimestampNameComponent convention.

Supported operations include those in convention::Segment, and:

name.append(region, convention::Timestamp(), convention::RandomValue());
name.append(region, convention::Timestamp(), convention::TimeValue(port::UnixTime::now()));

Version

using ndnph::convention::Version = typedef detail::TypedNumber<TT::VersionNameComponent>

VersionNameComponent convention.

Supported operations are same as convention::Timestamp.