Represents an Interest packet. More...

#include <ndn-cxx/interest.hpp>

Inheritance diagram for ndn::Interest:

Collaboration diagram for ndn::Interest:

Classes
class	Error

Public Member Functions
	Interest (const Name &name=Name(), time::milliseconds lifetime=DEFAULT_INTEREST_LIFETIME)
	Construct an Interest with given `name` and `lifetime`. More...

	Interest (const Block &wire)
	Construct an Interest by decoding from `wire`. More...

Block	getApplicationParameters () const

bool	getCanBePrefix () const noexcept
	Check whether the CanBePrefix element is present. More...

uint64_t	getCongestionMark () const
	get the value of the CongestionMark tag More...

const DelegationList &	getForwardingHint () const noexcept

optional< uint8_t >	getHopLimit () const noexcept

time::milliseconds	getInterestLifetime () const noexcept

bool	getMustBeFresh () const noexcept
	Check whether the MustBeFresh element is present. More...

const Name &	getName () const noexcept

uint32_t	getNonce () const
	Get nonce value. More...

template<typename T >
shared_ptr< T >	getTag () const
	get a tag item More...

bool	hasApplicationParameters () const noexcept

bool	hasNonce () const noexcept
	Check if the Nonce element is present. More...

bool	hasWire () const
	Check if this instance has cached wire encoding. More...

bool	isParametersDigestValid () const
	Check if the ParametersSha256DigestComponent in the name is valid. More...

bool	matchesData (const Data &data) const
	Check if Interest can be satisfied by `data`. More...

bool	matchesInterest (const Interest &other) const
	Check if this Interest matches `other`. More...

template<typename Modifier >
Interest &	modifyForwardingHint (const Modifier &modifier)
	Modify ForwardingHint in-place. More...

void	refreshNonce ()
	Change nonce value. More...

template<typename T >
void	removeTag () const
	remove tag item More...

Interest &	setApplicationParameters (const Block &parameters)
	Set ApplicationParameters from a Block. More...

Interest &	setApplicationParameters (const uint8_t *value, size_t length)
	Set ApplicationParameters by copying from a raw buffer. More...

Interest &	setApplicationParameters (ConstBufferPtr value)
	Set ApplicationParameters from a shared buffer. More...

Interest &	setCanBePrefix (bool canBePrefix)
	Add or remove CanBePrefix element. More...

void	setCongestionMark (uint64_t mark)
	set the CongestionMark tag to the specified value More...

Interest &	setForwardingHint (const DelegationList &value)

Interest &	setHopLimit (optional< uint8_t > hopLimit)
	Set the Interest's hop limit. More...

Interest &	setInterestLifetime (time::milliseconds lifetime)
	Set the Interest's lifetime. More...

Interest &	setMustBeFresh (bool mustBeFresh)
	Add or remove MustBeFresh element. More...

Interest &	setName (const Name &name)
	Set the Interest's name. More...

Interest &	setNonce (uint32_t nonce)
	Set nonce value. More...

template<typename T >
void	setTag (shared_ptr< T > tag) const
	set a tag item More...

std::string	toUri () const
	Return a URI-like string that represents the Interest. More...

Interest &	unsetApplicationParameters ()
	Remove the ApplicationParameters element from this Interest. More...

void	wireDecode (const Block &wire)
	Decode from `wire` according to NDN Packet Format v0.3. More...

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Prepend wire encoding to `encoder` according to NDN Packet Format v0.3. More...

const Block &	wireEncode () const
	Encode into a Block according to NDN Packet Format v0.3. More...

Static Public Member Functions
static bool	getAutoCheckParametersDigest ()

static void	setAutoCheckParametersDigest (bool b)

static void	setDefaultCanBePrefix (bool canBePrefix)
	Declare the default CanBePrefix setting of the application. More...

Detailed Description

Represents an Interest packet.

Definition at line 43 of file interest.hpp.

Constructor & Destructor Documentation

◆ Interest() [1/2]

ndn::Interest::Interest	(	const Name &	name = `Name()`,
		time::milliseconds	lifetime = `DEFAULT_INTEREST_LIFETIME`
	)

explicit

Construct an Interest with given name and lifetime.

Exceptions

std::invalid_argument name is invalid or lifetime is negative

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, shared_from_this() will trigger undefined behavior.

Definition at line 52 of file interest.cpp.

◆ Interest() [2/2]

ndn::Interest::Interest ( const Block & wire )

explicit

Construct an Interest by decoding from wire.

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, shared_from_this() will trigger undefined behavior.

Definition at line 62 of file interest.cpp.

Member Function Documentation

◆ getApplicationParameters()

Block ndn::Interest::getApplicationParameters ( ) const

inline

Definition at line 279 of file interest.hpp.

◆ getAutoCheckParametersDigest()

static bool ndn::Interest::getAutoCheckParametersDigest ( )

inlinestatic

Definition at line 336 of file interest.hpp.

◆ getCanBePrefix()

bool ndn::Interest::getCanBePrefix ( ) const

inlinenoexcept

Check whether the CanBePrefix element is present.

Definition at line 155 of file interest.hpp.

◆ getCongestionMark()

uint64_t ndn::PacketBase::getCongestionMark ( ) const

inherited

get the value of the CongestionMark tag

Definition at line 28 of file packet-base.cpp.

◆ getForwardingHint()

const DelegationList& ndn::Interest::getForwardingHint ( ) const

inlinenoexcept

Definition at line 192 of file interest.hpp.

◆ getHopLimit()

optional<uint8_t> ndn::Interest::getHopLimit ( ) const

inlinenoexcept

Definition at line 260 of file interest.hpp.

◆ getInterestLifetime()

time::milliseconds ndn::Interest::getInterestLifetime ( ) const

inlinenoexcept

Definition at line 248 of file interest.hpp.

◆ getMustBeFresh()

bool ndn::Interest::getMustBeFresh ( ) const

inlinenoexcept

Check whether the MustBeFresh element is present.

Definition at line 175 of file interest.hpp.

◆ getName()

const Name& ndn::Interest::getName ( ) const

inlinenoexcept

Definition at line 121 of file interest.hpp.

◆ getNonce()

uint32_t ndn::Interest::getNonce ( ) const

Get nonce value.

If nonce was not present, it is added and assigned a random value.

Definition at line 400 of file interest.cpp.

◆ getTag()

template<typename T >

shared_ptr< T > ndn::TagHost::getTag ( ) const

inherited

get a tag item

Template Parameters

T	type of the tag, which must be a subclass of ndn::Tag

Return values

nullptr if no Tag of type T is stored

Definition at line 66 of file tag-host.hpp.

◆ hasApplicationParameters()

bool ndn::Interest::hasApplicationParameters ( ) const

inlinenoexcept

Definition at line 273 of file interest.hpp.

◆ hasNonce()

bool ndn::Interest::hasNonce ( ) const

inlinenoexcept

Check if the Nonce element is present.

Definition at line 222 of file interest.hpp.

◆ hasWire()

bool ndn::Interest::hasWire ( ) const

inline

Check if this instance has cached wire encoding.

Definition at line 88 of file interest.hpp.

◆ isParametersDigestValid()

bool ndn::Interest::isParametersDigestValid ( ) const

Check if the ParametersSha256DigestComponent in the name is valid.

Returns true if there is a single ParametersSha256DigestComponent in the name and the digest value is correct, or if there is no ParametersSha256DigestComponent in the name and the Interest does not contain any parameters. Returns false otherwise.

Definition at line 524 of file interest.cpp.

◆ matchesData()

bool ndn::Interest::matchesData ( const Data & data ) const

Check if Interest can be satisfied by data.

This method considers Name, CanBePrefix, and MustBeFresh. However, MustBeFresh processing is limited to rejecting Data with zero/omitted FreshnessPeriod.

Definition at line 333 of file interest.cpp.

◆ matchesInterest()

bool ndn::Interest::matchesInterest ( const Interest & other ) const

Check if this Interest matches other.

Two Interests match if both have the same Name, CanBePrefix, and MustBeFresh.

Definition at line 365 of file interest.cpp.

◆ modifyForwardingHint()

template<typename Modifier >

Interest& ndn::Interest::modifyForwardingHint ( const Modifier & modifier )

inline

Modify ForwardingHint in-place.

Template Parameters

Modifier a unary function that accepts DelegationList&

This is equivalent to, but more efficient (avoids copying) than:

auto fh = interest.getForwardingHint();
modifier(fh);
interest.setForwardingHint(fh);

Definition at line 212 of file interest.hpp.

◆ refreshNonce()

void ndn::Interest::refreshNonce ( )

Change nonce value.

If the Nonce element is present, the new nonce value will differ from the old value. If the Nonce element is not present, this method does nothing.

Definition at line 420 of file interest.cpp.

◆ removeTag()

template<typename T >

void ndn::TagHost::removeTag ( ) const

inherited

remove tag item

Note: Tag can be removed even on a const tag host instance

Definition at line 93 of file tag-host.hpp.

◆ setApplicationParameters() [1/3]

Interest & ndn::Interest::setApplicationParameters ( const Block & parameters )

Set ApplicationParameters from a Block.

Returns: a reference to this Interest

If the block is default-constructed, this will set a zero-length ApplicationParameters element. Else, if the block's TLV-TYPE is ApplicationParameters, it will be used directly as this Interest's ApplicationParameters element. Else, the block will be nested into an ApplicationParameters element.

This function will also recompute the value of the ParametersSha256DigestComponent in the Interest's name. If the name does not contain a ParametersSha256DigestComponent, one will be appended to it.

Definition at line 469 of file interest.cpp.

◆ setApplicationParameters() [2/3]

Interest & ndn::Interest::setApplicationParameters	(	const uint8_t *	value,
		size_t	length
	)

Set ApplicationParameters by copying from a raw buffer.

Parameters

value	points to a buffer from which the TLV-VALUE of the parameters will be copied; may be nullptr if `length` is zero
length	size of the buffer

Returns: a reference to this Interest

This function will also recompute the value of the ParametersSha256DigestComponent in the Interest's name. If the name does not contain a ParametersSha256DigestComponent, one will be appended to it.

Definition at line 486 of file interest.cpp.

◆ setApplicationParameters() [3/3]

Interest & ndn::Interest::setApplicationParameters ( ConstBufferPtr value )

Set ApplicationParameters from a shared buffer.

Parameters

value buffer containing the TLV-VALUE of the parameters; must not be nullptr

Returns: a reference to this Interest

This function will also recompute the value of the ParametersSha256DigestComponent in the Interest's name. If the name does not contain a ParametersSha256DigestComponent, one will be appended to it.

Definition at line 498 of file interest.cpp.

◆ setAutoCheckParametersDigest()

static void ndn::Interest::setAutoCheckParametersDigest ( bool b )

inlinestatic

Definition at line 342 of file interest.hpp.

◆ setCanBePrefix()

Interest& ndn::Interest::setCanBePrefix ( bool canBePrefix )

inline

Add or remove CanBePrefix element.

Parameters

canBePrefix whether CanBePrefix element should be present.

Definition at line 164 of file interest.hpp.

◆ setCongestionMark()

void ndn::PacketBase::setCongestionMark ( uint64_t mark )

inherited

set the CongestionMark tag to the specified value

Definition at line 41 of file packet-base.cpp.

◆ setDefaultCanBePrefix()

static void ndn::Interest::setDefaultCanBePrefix ( bool canBePrefix )

inlinestatic

Declare the default CanBePrefix setting of the application.

As part of transitioning to NDN Packet Format v0.3, the default setting for CanBePrefix will be changed from "true" to "false". Application developers are advised to review all Interests expressed by their application and decide what CanBePrefix setting is appropriate for each Interest, to avoid breaking changes when the transition occurs. Application may either set CanBePrefix on a per-Interest basis, or declare a default CanBePrefix setting for all Interests expressed by the application using this function. If an application neither declares a default nor sets CanBePrefix on every Interest, Interest::wireEncode will print a one-time warning message.

Note: This function should not be used in libraries or in ndn-cxx unit tests.

See also: https://redmine.named-data.net/projects/nfd/wiki/Packet03Transition

Definition at line 147 of file interest.hpp.

◆ setForwardingHint()

Interest & ndn::Interest::setForwardingHint ( const DelegationList & value )

Definition at line 392 of file interest.cpp.

◆ setHopLimit()

Interest & ndn::Interest::setHopLimit ( optional< uint8_t > hopLimit )

Set the Interest's hop limit.

Use setHopLimit(nullopt) to remove any hop limit from the Interest.

Definition at line 446 of file interest.cpp.

◆ setInterestLifetime()

Interest & ndn::Interest::setInterestLifetime ( time::milliseconds lifetime )

Set the Interest's lifetime.

Exceptions

std::invalid_argument lifetime is negative

Definition at line 433 of file interest.cpp.

◆ setMustBeFresh()

Interest& ndn::Interest::setMustBeFresh ( bool mustBeFresh )

inline

Add or remove MustBeFresh element.

Parameters

mustBeFresh whether MustBeFresh element should be present.

Definition at line 184 of file interest.hpp.

◆ setName()

Interest & ndn::Interest::setName ( const Name & name )

Set the Interest's name.

Exceptions

std::invalid_argument name is invalid

Definition at line 375 of file interest.cpp.

◆ setNonce()

Interest & ndn::Interest::setNonce ( uint32_t nonce )

Set nonce value.

Definition at line 410 of file interest.cpp.

◆ setTag()

template<typename T >

void ndn::TagHost::setTag ( shared_ptr< T > tag ) const

inherited

set a tag item

Template Parameters

T	type of the tag, which must be a subclass of ndn::Tag

Note: Tag can be set even on a const tag host instance

Definition at line 79 of file tag-host.hpp.

◆ toUri()

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

Return a URI-like string that represents the Interest.

The string always starts with getName().toUri(). After the name, if any of the Interest's CanBePrefix, MustBeFresh, Nonce, InterestLifetime, or HopLimit fields are present, their textual representation is appended as a query string. Example: "/test/name?MustBeFresh&Nonce=123456"

Definition at line 323 of file interest.cpp.

◆ unsetApplicationParameters()

Interest & ndn::Interest::unsetApplicationParameters ( )

Remove the ApplicationParameters element from this Interest.

Postcondition: hasApplicationParameters() == false

This function will also remove any ParametersSha256DigestComponents from the Interest's name.

Definition at line 510 of file interest.cpp.

◆ wireDecode()

void ndn::Interest::wireDecode ( const Block & wire )

Decode from wire according to NDN Packet Format v0.3.

Definition at line 186 of file interest.cpp.

◆ wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::Interest::wireEncode ( EncodingImpl< TAG > & encoder ) const

Prepend wire encoding to encoder according to NDN Packet Format v0.3.

Definition at line 87 of file interest.cpp.

◆ wireEncode() [2/2]

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

Encode into a Block according to NDN Packet Format v0.3.

Definition at line 170 of file interest.cpp.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.7.0 documentation

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Interest() [1/2]

◆ Interest() [2/2]

Member Function Documentation

◆ getApplicationParameters()

◆ getAutoCheckParametersDigest()

◆ getCanBePrefix()

◆ getCongestionMark()

◆ getForwardingHint()

◆ getHopLimit()

◆ getInterestLifetime()

◆ getMustBeFresh()

◆ getName()

◆ getNonce()

◆ getTag()

◆ hasApplicationParameters()

◆ hasNonce()

◆ hasWire()

◆ isParametersDigestValid()

◆ matchesData()

◆ matchesInterest()

◆ modifyForwardingHint()

◆ refreshNonce()

◆ removeTag()

◆ setApplicationParameters() [1/3]

◆ setApplicationParameters() [2/3]

◆ setApplicationParameters() [3/3]

◆ setAutoCheckParametersDigest()

◆ setCanBePrefix()

◆ setCongestionMark()

◆ setDefaultCanBePrefix()

◆ setForwardingHint()

◆ setHopLimit()

◆ setInterestLifetime()

◆ setMustBeFresh()

◆ setName()

◆ setNonce()

◆ setTag()

◆ toUri()

◆ unsetApplicationParameters()

◆ wireDecode()

◆ wireEncode() [1/2]

◆ wireEncode() [2/2]