NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::Name Class Reference

Represents an absolute name. More...

#include <name.hpp>

Collaboration diagram for ndn::Name:

Classes

class  Error
 

Public Types

using Component = name::Component
 
using component_container = std::vector< Component >
 
using value_type = Component
 
using allocator_type = void
 
using reference = Component &
 
using const_reference = const Component &
 
using pointer = Component *
 
using const_pointer = const Component *
 
using iterator = const Component *
 
using const_iterator = const Component *
 
using reverse_iterator = std::reverse_iterator< iterator >
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using difference_type = component_container::difference_type
 
using size_type = component_container::size_type
 

Public Member Functions

 Name ()
 Create an empty name. More...
 
 Name (const Block &wire)
 Decode Name from wire encoding. More...
 
 Name (const char *uri)
 Parse name from NDN URI. More...
 
 Name (std::string uri)
 Create name from NDN URI. More...
 
std::string toUri () const
 Get URI representation of the name. More...
 
bool hasWire () const
 Check if this Name instance already has wire encoding. More...
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 Fast encoding or block size estimation. More...
 
const BlockwireEncode () const
 Perform wire encoding, or return existing wire encoding. More...
 
void wireDecode (const Block &wire)
 Decode name from wire encoding. More...
 
Name deepCopy () const
 Make a deep copy of the name, reallocating the underlying memory buffer. More...
 
bool empty () const
 Check if name is empty. More...
 
size_t size () const
 Get number of components. More...
 
const Componentget (ssize_t i) const
 Get the component at the given index. More...
 
const Componentoperator[] (ssize_t i) const
 Equivalent to get(i) More...
 
const Componentat (ssize_t i) const
 Get the component at the given index. More...
 
PartialName getSubName (ssize_t iStartComponent, size_t nComponents=npos) const
 Extract some components as a sub-name (PartialName) More...
 
PartialName getPrefix (ssize_t nComponents) const
 Extract a prefix of the name. More...
 
const_iterator begin () const
 Begin iterator. More...
 
const_iterator end () const
 End iterator. More...
 
const_reverse_iterator rbegin () const
 Reverse begin iterator. More...
 
const_reverse_iterator rend () const
 Reverse end iterator. More...
 
Nameappend (const Component &component)
 Append a component. More...
 
Nameappend (uint32_t type, const uint8_t *value, size_t count)
 Append a NameComponent of TLV-TYPE type, copying count bytes at value as TLV-VALUE. More...
 
Nameappend (const uint8_t *value, size_t count)
 Append a GenericNameComponent, copying count bytes at value as TLV-VALUE. More...
 
template<class Iterator >
Nameappend (uint32_t type, Iterator first, Iterator last)
 Append a NameComponent of TLV-TYPE type, copying TLV-VALUE from a range. More...
 
template<class Iterator >
Nameappend (Iterator first, Iterator last)
 Append a GenericNameComponent, copying TLV-VALUE from a range. More...
 
Nameappend (const char *str)
 Append a GenericNameComponent, copying TLV-VALUE from a null-terminated string. More...
 
Nameappend (const Block &value)
 Append a GenericNameComponent from a TLV element. More...
 
NameappendNumber (uint64_t number)
 Append a component with a nonNegativeInteger. More...
 
NameappendNumberWithMarker (uint8_t marker, uint64_t number)
 Append a component with a marked number. More...
 
NameappendVersion (uint64_t version)
 Append a version component. More...
 
NameappendVersion ()
 Append a version component based on current time. More...
 
NameappendSegment (uint64_t segmentNo)
 Append a segment number (sequential) component. More...
 
NameappendSegmentOffset (uint64_t offset)
 Append a segment byte offset component. More...
 
NameappendTimestamp (const time::system_clock::TimePoint &timePoint)
 Append a timestamp component. More...
 
NameappendTimestamp ()
 Append a timestamp component based on current time. More...
 
NameappendSequenceNumber (uint64_t seqNo)
 Append a sequence number component. More...
 
NameappendImplicitSha256Digest (const ConstBufferPtr &digest)
 Append an ImplicitSha256Digest component. More...
 
NameappendImplicitSha256Digest (const uint8_t *digest, size_t digestSize)
 Append an ImplicitSha256Digest component. More...
 
Nameappend (const PartialName &name)
 Append a PartialName. More...
 
template<class T >
void push_back (const T &component)
 Append a component. More...
 
void clear ()
 Remove all components. More...
 
Name getSuccessor () const
 Get the successor of a name. More...
 
bool isPrefixOf (const Name &other) const
 Check if this name is a prefix of another name. More...
 
bool equals (const Name &other) const
 Check if this name equals another name. More...
 
int compare (const Name &other) const
 Compare this to the other Name using NDN canonical ordering. More...
 
int compare (size_t pos1, size_t count1, const Name &other, size_t pos2=0, size_t count2=npos) const
 compares [pos1, pos1+count1) components in this Name to [pos2, pos2+count2) components in other More...
 

Static Public Attributes

static const size_t npos = std::numeric_limits<size_t>::max()
 indicates "until the end" in getSubName and compare More...
 

Detailed Description

Represents an absolute name.

Definition at line 42 of file name.hpp.

Member Typedef Documentation

◆ Component

Definition at line 55 of file name.hpp.

◆ component_container

Definition at line 56 of file name.hpp.

◆ value_type

Definition at line 59 of file name.hpp.

◆ allocator_type

Definition at line 60 of file name.hpp.

◆ reference

Definition at line 61 of file name.hpp.

◆ const_reference

Definition at line 62 of file name.hpp.

◆ pointer

Definition at line 63 of file name.hpp.

◆ const_pointer

Definition at line 64 of file name.hpp.

◆ iterator

Definition at line 65 of file name.hpp.

◆ const_iterator

Definition at line 66 of file name.hpp.

◆ reverse_iterator

using ndn::Name::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 67 of file name.hpp.

◆ const_reverse_iterator

using ndn::Name::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 68 of file name.hpp.

◆ difference_type

using ndn::Name::difference_type = component_container::difference_type

Definition at line 69 of file name.hpp.

◆ size_type

using ndn::Name::size_type = component_container::size_type

Definition at line 70 of file name.hpp.

Constructor & Destructor Documentation

◆ Name() [1/4]

ndn::Name::Name ( )

Create an empty name.

Postcondition
empty() == true

Definition at line 55 of file name.cpp.

◆ Name() [2/4]

ndn::Name::Name ( const Block wire)
explicit

Decode Name from wire encoding.

Exceptions
tlv::Errorwire encoding is invalid

This is a more efficient equivalent for

name.wireDecode(wire);

Definition at line 60 of file name.cpp.

References ndn::Block::parse().

◆ Name() [3/4]

ndn::Name::Name ( const char *  uri)

Parse name from NDN URI.

Parameters
uria null-terminated URI string
See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#ndn-uri-scheme

Definition at line 66 of file name.cpp.

◆ Name() [4/4]

ndn::Name::Name ( std::string  uri)

Create name from NDN URI.

Parameters
uria URI string
See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#ndn-uri-scheme

Definition at line 71 of file name.cpp.

References append(), and ndn::name::Component::fromEscapedString().

Member Function Documentation

◆ toUri()

std::string ndn::Name::toUri ( ) const

Get URI representation of the name.

Returns
URI representation; "ndn:" scheme identifier is not included
See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#ndn-uri-scheme
Note
To print URI representation into a stream, it is more efficient to use os << name.

Definition at line 117 of file name.cpp.

Referenced by ndn::security::pib::CertificateContainer::add(), ndn::security::pib::KeyContainer::add(), ndn::security::v2::KeyChain::addCertificate(), ndn::security::v2::ValidationPolicySimpleHierarchy::checkPolicy(), ndn::security::v2::validator_config::ValidationPolicyConfig::checkPolicy(), ndn::security::tpm::BackEnd::createKey(), ndn::security::v2::KeyChain::deleteCertificate(), ndn::security::v2::KeyChain::deleteKey(), ndn::security::tpm::BackEnd::exportKey(), ndn::security::v2::KeyChain::exportSafeBag(), ndn::security::v2::extractIdentityFromCertName(), ndn::security::v2::extractIdentityFromKeyName(), ndn::security::v2::extractKeyNameFromCertName(), ndn::security::pib::CertificateContainer::get(), ndn::security::pib::KeyContainer::get(), ndn::security::pib::PibMemory::getCertificate(), ndn::security::pib::PibSqlite3::getCertificate(), ndn::security::pib::PibMemory::getDefaultCertificateOfKey(), ndn::security::pib::PibSqlite3::getDefaultCertificateOfKey(), ndn::security::pib::PibMemory::getDefaultKeyOfIdentity(), ndn::security::pib::PibSqlite3::getDefaultKeyOfIdentity(), ndn::security::tpm::BackEndOsx::Impl::getKey(), ndn::security::pib::PibMemory::getKeyBits(), ndn::security::pib::PibSqlite3::getKeyBits(), ndn::security::pib::detail::IdentityImpl::IdentityImpl(), ndn::security::tpm::BackEnd::importKey(), ndn::security::v2::KeyChain::importSafeBag(), ndn::security::pib::CertificateContainer::remove(), ndn::security::pib::KeyContainer::remove(), ndn::security::pib::PibMemory::setDefaultCertificateOfKey(), ndn::security::pib::PibSqlite3::setDefaultCertificateOfKey(), ndn::security::v2::KeyChain::setDefaultKey(), ndn::security::pib::PibMemory::setDefaultKeyOfIdentity(), and ndn::security::pib::PibSqlite3::setDefaultKeyOfIdentity().

◆ hasWire()

bool ndn::Name::hasWire ( ) const
inline

Check if this Name instance already has wire encoding.

Definition at line 113 of file name.hpp.

References ndn::Block::hasWire().

◆ wireEncode() [1/2]

template<encoding::Tag TAG>
size_t ndn::Name::wireEncode ( EncodingImpl< TAG > &  encoder) const

◆ wireEncode() [2/2]

const Block & ndn::Name::wireEncode ( ) const

Perform wire encoding, or return existing wire encoding.

Postcondition
hasWire() == true

Definition at line 141 of file name.cpp.

References ndn::Block::hasWire(), and ndn::Block::parse().

◆ wireDecode()

void ndn::Name::wireDecode ( const Block wire)

◆ deepCopy()

Name ndn::Name::deepCopy ( ) const

Make a deep copy of the name, reallocating the underlying memory buffer.

Definition at line 169 of file name.cpp.

References ndn::Block::resetWire(), and wireEncode().

◆ empty()

◆ size()

◆ get()

const Component& ndn::Name::get ( ssize_t  i) const
inline

Get the component at the given index.

Parameters
izero-based index; if negative, it starts at the end of this name
Warning
Indexing out of bounds triggers undefined behavior.

Definition at line 164 of file name.hpp.

References ndn::Block::elements(), and size().

Referenced by compare(), ndn::security::v2::CertificateBundleFetcher::doFetch(), equals(), getSuccessor(), isPrefixOf(), ndn::security::v2::isValidKeyName(), ndn::security::v2::Certificate::isValidName(), ndn::Interest::matchesData(), and operator[]().

◆ operator[]()

const Component& ndn::Name::operator[] ( ssize_t  i) const
inline

Equivalent to get(i)

Definition at line 175 of file name.hpp.

References get().

◆ at()

const name::Component & ndn::Name::at ( ssize_t  i) const

Get the component at the given index.

Parameters
izero-based index; if negative, size()+i is used instead
Exceptions
Name::Errorindex is out of bounds

Definition at line 180 of file name.cpp.

References ndn::Block::elements(), and size().

Referenced by nfd::ManagerBase::extractRequester(), ndn::lp::PrefixAnnouncement::getAnnouncedName(), ndn::security::v2::Certificate::getIssuerId(), ndn::security::v2::Certificate::getKeyId(), getSubName(), and nfd::fw::Strategy::makeInstanceName().

◆ getSubName()

PartialName ndn::Name::getSubName ( ssize_t  iStartComponent,
size_t  nComponents = npos 
) const

Extract some components as a sub-name (PartialName)

Parameters
iStartComponentzero-based index of the first component; if negative, size()+iStartComponent is used instead
nComponentsNumber of components starting at iStartComponent. Use npos to get the PartialName until the end of this Name.
Returns
a new PartialName containing the extracted components

If iStartComponent is positive and indexes out of bounds, returns an empty PartialName. If iStartComponent is negative and indexes out of bounds, returns components starting from the beginning of the Name. If nComponents is out of bounds, returns the components until the end of this Name.

Definition at line 194 of file name.cpp.

References append(), at(), npos, and size().

Referenced by ndn::lp::PrefixAnnouncement::getAnnouncedName(), getPrefix(), and nfd::fw::Strategy::parseInstanceName().

◆ getPrefix()

◆ begin()

const_iterator ndn::Name::begin ( ) const
inline

Begin iterator.

Definition at line 222 of file name.hpp.

References ndn::Block::elements().

Referenced by rend().

◆ end()

const_iterator ndn::Name::end ( ) const
inline

End iterator.

Definition at line 230 of file name.hpp.

References ndn::Block::elements().

Referenced by rbegin().

◆ rbegin()

const_reverse_iterator ndn::Name::rbegin ( ) const
inline

Reverse begin iterator.

Definition at line 238 of file name.hpp.

References end().

Referenced by nfd::fw::Strategy::makeInstanceName().

◆ rend()

const_reverse_iterator ndn::Name::rend ( ) const
inline

Reverse end iterator.

Definition at line 246 of file name.hpp.

References begin().

Referenced by nfd::fw::Strategy::makeInstanceName().

◆ append() [1/8]

◆ append() [2/8]

Name& ndn::Name::append ( uint32_t  type,
const uint8_t *  value,
size_t  count 
)
inline

Append a NameComponent of TLV-TYPE type, copying count bytes at value as TLV-VALUE.

Returns
a reference to this name, to allow chaining.

Definition at line 267 of file name.hpp.

References append().

◆ append() [3/8]

Name& ndn::Name::append ( const uint8_t *  value,
size_t  count 
)
inline

Append a GenericNameComponent, copying count bytes at value as TLV-VALUE.

Returns
a reference to this name, to allow chaining.

Definition at line 276 of file name.hpp.

References append().

◆ append() [4/8]

template<class Iterator >
Name& ndn::Name::append ( uint32_t  type,
Iterator  first,
Iterator  last 
)
inline

Append a NameComponent of TLV-TYPE type, copying TLV-VALUE from a range.

Template Parameters
Iteratoran InputIterator dereferencing to a one-octet value type. More efficient implementation is available when it is a RandomAccessIterator.
Parameters
typethe TLV-TYPE.
firstbeginning of the range.
lastpast-end of the range.
Returns
a reference to this name, to allow chaining.

Definition at line 291 of file name.hpp.

References append().

◆ append() [5/8]

template<class Iterator >
Name& ndn::Name::append ( Iterator  first,
Iterator  last 
)
inline

Append a GenericNameComponent, copying TLV-VALUE from a range.

Template Parameters
Iteratoran InputIterator dereferencing to a one-octet value type. More efficient implementation is available when it is a RandomAccessIterator.
Parameters
firstbeginning of the range.
lastpast-end of the range.
Returns
a reference to this name, to allow chaining.

Definition at line 305 of file name.hpp.

References append().

◆ append() [6/8]

Name& ndn::Name::append ( const char *  str)
inline

Append a GenericNameComponent, copying TLV-VALUE from a null-terminated string.

Parameters
stra null-terminated string. Bytes from the string are copied as is, and not interpreted as URI component.
Returns
a reference to this name, to allow chaining.

Definition at line 316 of file name.hpp.

References append().

◆ append() [7/8]

Name& ndn::Name::append ( const Block value)
inline

Append a GenericNameComponent from a TLV element.

Parameters
valuea TLV element. If its type is tlv::GenericNameComponent, it is used as is. Otherwise, it is encapsulated into a GenericNameComponent.
Returns
a reference to this name, to allow chaining.

Definition at line 327 of file name.hpp.

References ndn::tlv::GenericNameComponent, ndn::Block::push_back(), and ndn::Block::type().

◆ appendNumber()

Name& ndn::Name::appendNumber ( uint64_t  number)
inline

Append a component with a nonNegativeInteger.

See also
number the number
Returns
a reference to this name, to allow chaining
See also
https://named-data.net/doc/NDN-packet-spec/current/tlv.html#non-negative-integer-encoding

Definition at line 344 of file name.hpp.

References append(), and ndn::name::Component::fromNumber().

◆ appendNumberWithMarker()

Name& ndn::Name::appendNumberWithMarker ( uint8_t  marker,
uint64_t  number 
)
inline

Append a component with a marked number.

Parameters
marker1-octet marker
numberthe number

The component is encoded as a 1-octet marker, followed by a nonNegativeInteger.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 359 of file name.hpp.

References append(), and ndn::name::Component::fromNumberWithMarker().

◆ appendVersion() [1/2]

Name& ndn::Name::appendVersion ( uint64_t  version)
inline

Append a version component.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 369 of file name.hpp.

References append(), and ndn::name::Component::fromVersion().

Referenced by ndn::mgmt::StatusDatasetContext::setPrefix().

◆ appendVersion() [2/2]

Name & ndn::Name::appendVersion ( )

Append a version component based on current time.

The version number is the current UNIX timestamp in milliseconds

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 215 of file name.cpp.

References ndn::time::system_clock::now(), and ndn::time::toUnixTimestamp().

◆ appendSegment()

Name& ndn::Name::appendSegment ( uint64_t  segmentNo)
inline

Append a segment number (sequential) component.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 389 of file name.hpp.

References append(), and ndn::name::Component::fromSegment().

◆ appendSegmentOffset()

Name& ndn::Name::appendSegmentOffset ( uint64_t  offset)
inline

Append a segment byte offset component.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 399 of file name.hpp.

References append(), and ndn::name::Component::fromSegmentOffset().

◆ appendTimestamp() [1/2]

Name& ndn::Name::appendTimestamp ( const time::system_clock::TimePoint timePoint)
inline

Append a timestamp component.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 409 of file name.hpp.

References append(), and ndn::name::Component::fromTimestamp().

◆ appendTimestamp() [2/2]

Name & ndn::Name::appendTimestamp ( )

Append a timestamp component based on current time.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 221 of file name.cpp.

References ndn::time::system_clock::now().

◆ appendSequenceNumber()

Name& ndn::Name::appendSequenceNumber ( uint64_t  seqNo)
inline

Append a sequence number component.

Returns
a reference to this name, to allow chaining
See also
NDN Naming Conventions https://named-data.net/doc/tech-memos/naming-conventions.pdf

Definition at line 426 of file name.hpp.

References append(), and ndn::name::Component::fromSequenceNumber().

Referenced by ndn::util::NotificationStream< Notification >::postNotification().

◆ appendImplicitSha256Digest() [1/2]

Name& ndn::Name::appendImplicitSha256Digest ( const ConstBufferPtr digest)
inline

Append an ImplicitSha256Digest component.

Returns
a reference to this name, to allow chaining

Definition at line 435 of file name.hpp.

References append(), and ndn::name::Component::fromImplicitSha256Digest().

Referenced by ndn::Data::getFullName().

◆ appendImplicitSha256Digest() [2/2]

Name& ndn::Name::appendImplicitSha256Digest ( const uint8_t *  digest,
size_t  digestSize 
)
inline

Append an ImplicitSha256Digest component.

Returns
a reference to this name, to allow chaining

Definition at line 444 of file name.hpp.

References append(), and ndn::name::Component::fromImplicitSha256Digest().

◆ append() [8/8]

Name & ndn::Name::append ( const PartialName name)

Append a PartialName.

Parameters
namethe components to append
Returns
a reference to this name, to allow chaining

Definition at line 227 of file name.cpp.

References append().

◆ push_back()

template<class T >
void ndn::Name::push_back ( const T &  component)
inline

Append a component.

Note
This makes push_back an alias of append, giving Name a similar API as STL vector.

Definition at line 461 of file name.hpp.

References append().

◆ clear()

◆ getSuccessor()

Name ndn::Name::getSuccessor ( ) const

Get the successor of a name.

The successor of a name is defined as follows:

N represents the set of NDN Names, and X,Y ∈ N.
Operator < is defined by canonical order on N.
Y is the successor of X, if (a) X < Y, and (b) ∄ Z ∈ N s.t. X < Z < Y.

In plain words, successor of a name is the same name, but with its last component advanced to a next possible value.

Examples:

  • successor for / is /%00
  • successor for /%00%01/%01%02 is /%00%01/%01%03
  • successor for /%00%01/%01FF is /%00%01/%02%00
  • successor for /%00%01/FFFF is /%00%01/%00%00%00
Returns
a new Name containing the successor

Definition at line 242 of file name.cpp.

References append(), empty(), get(), and getPrefix().

Referenced by nfd::cs::Cs::erase(), and nfd::cs::Cs::find().

◆ isPrefixOf()

bool ndn::Name::isPrefixOf ( const Name other) const

◆ equals()

bool ndn::Name::equals ( const Name other) const

Check if this name equals another name.

Two names are equal if they have the same number of components, and components at each index are equal.

Definition at line 271 of file name.cpp.

References get(), and size().

Referenced by ndn::operator!=(), and ndn::operator==().

◆ compare() [1/2]

int ndn::Name::compare ( const Name other) const
inline

Compare this to the other Name using NDN canonical ordering.

If the first components of each name are not equal, this returns a negative value if the first comes before the second using the NDN canonical ordering for name components, or a positive value if it comes after. If they are equal, this compares the second components of each name, etc. If both names are the same up to the size of the shorter name, this returns a negative value if the first name is shorter than the second or a positive value if it is longer. For example, if you std::sort gives: /a/b/d /a/b/cc /c /c/a /bb . This is intuitive because all names with the prefix /a are next to each other. But it may be also be counter-intuitive because /c comes before /bb according to NDN canonical ordering since it is shorter.

Parameters
otherThe other Name to compare with.
Return values
negativethis comes before other in canonical ordering
zerothis equals other
positivethis comes after other in canonical ordering
See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#canonical-order

Definition at line 540 of file name.hpp.

References npos.

Referenced by nfd::cs::compareDataWithData(), nfd::cs::compareQueryWithData(), ndn::operator<(), ndn::operator<=(), ndn::operator>(), and ndn::operator>=().

◆ compare() [2/2]

int ndn::Name::compare ( size_t  pos1,
size_t  count1,
const Name other,
size_t  pos2 = 0,
size_t  count2 = npos 
) const

compares [pos1, pos1+count1) components in this Name to [pos2, pos2+count2) components in other

This is equivalent to this->getSubName(pos1, count1).compare(other.getSubName(pos2, count2));

Definition at line 285 of file name.cpp.

References ndn::name::Component::compare(), get(), and size().

Member Data Documentation

◆ npos

const size_t ndn::Name::npos = std::numeric_limits<size_t>::max()
static

indicates "until the end" in getSubName and compare

Definition at line 557 of file name.hpp.

Referenced by nfd::pit::Entry::canMatch(), compare(), and getSubName().


The documentation for this class was generated from the following files: