ndn::Interest Class Reference

Represents an Interest packet. More...

#include <ndn-cxx/interest.hpp>

+ Inheritance diagram for ndn::Interest:
+ Collaboration diagram for ndn::Interest:

Classes

class  Error
 
class  Nonce
 

Public Member Functions

 Interest (const Block &wire)
 Construct an Interest by decoding from wire. More...
 
 Interest (const Name &name=Name(), time::milliseconds lifetime=DEFAULT_INTEREST_LIFETIME)
 Construct an Interest with given name and lifetime. More...
 
InputBuffers extractSignedRanges () const
 Extract ranges of Interest covered by the signature in Packet Specification v0.3. More...
 
Block getApplicationParameters () const
 Get the ApplicationParameters. More...
 
bool getCanBePrefix () const noexcept
 Check whether the CanBePrefix element is present. More...
 
uint64_t getCongestionMark () const
 get the value of the CongestionMark tag More...
 
span< const NamegetForwardingHint () 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 NamegetName () const noexcept
 
Nonce getNonce () const
 Get nonce value. More...
 
optional< SignatureInfogetSignatureInfo () const
 Get the InterestSignatureInfo. More...
 
Block getSignatureValue () const
 Get the InterestSignatureValue. More...
 
template<typename T >
shared_ptr< T > getTag () const
 get a tag item More...
 
bool hasApplicationParameters () const noexcept
 Return whether this Interest has any ApplicationParameters. More...
 
bool hasNonce () const noexcept
 Check if the Nonce element is present. More...
 
bool hasWire () const noexcept
 Check if this instance has cached wire encoding. More...
 
bool isParametersDigestValid () const
 Check if the ParametersSha256DigestComponent in the name is valid. More...
 
bool isSigned () const noexcept
 Return whether the Interest is signed. 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...
 
void refreshNonce ()
 Change nonce value. More...
 
template<typename T >
void removeTag () const
 remove tag item More...
 
InterestsetApplicationParameters (const Block &block)
 Set ApplicationParameters from a Block. More...
 
InterestsetApplicationParameters (const uint8_t *value, size_t length)
 Set ApplicationParameters by copying from a raw buffer. More...
 
InterestsetApplicationParameters (ConstBufferPtr value)
 Set ApplicationParameters from a shared buffer. More...
 
InterestsetApplicationParameters (span< const uint8_t > value)
 Set ApplicationParameters by copying from a contiguous sequence of bytes. More...
 
InterestsetCanBePrefix (bool canBePrefix)
 Add or remove CanBePrefix element. More...
 
void setCongestionMark (uint64_t mark)
 set the CongestionMark tag to the specified value More...
 
InterestsetForwardingHint (std::vector< Name > value)
 
InterestsetHopLimit (optional< uint8_t > hopLimit)
 Set the Interest's hop limit. More...
 
InterestsetInterestLifetime (time::milliseconds lifetime)
 Set the Interest's lifetime. More...
 
InterestsetMustBeFresh (bool mustBeFresh)
 Add or remove MustBeFresh element. More...
 
InterestsetName (const Name &name)
 Set the Interest's name. More...
 
InterestsetNonce (optional< Nonce > nonce)
 Set the Interest's nonce. More...
 
InterestsetSignatureInfo (const SignatureInfo &info)
 Set the InterestSignatureInfo. More...
 
InterestsetSignatureValue (ConstBufferPtr value)
 Set the InterestSignatureValue. 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...
 
InterestunsetApplicationParameters ()
 Remove the ApplicationParameters element from this Interest. More...
 
void wireDecode (const Block &wire)
 Decode from wire. More...
 
const BlockwireEncode () const
 Encode into a Block. More...
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 Prepend wire encoding to encoder. 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.

See also
https://named-data.net/doc/NDN-packet-spec/0.3/interest.html

Definition at line 49 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_argumentname 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 46 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 56 of file interest.cpp.

Member Function Documentation

◆ extractSignedRanges()

InputBuffers ndn::Interest::extractSignedRanges ( ) const

Extract ranges of Interest covered by the signature in Packet Specification v0.3.

Exceptions
ErrorInterest cannot be encoded or is missing ranges necessary for signing
Warning
The returned pointers will be invalidated if wireDecode() or wireEncode() are called.

Definition at line 643 of file interest.cpp.

◆ getApplicationParameters()

Block ndn::Interest::getApplicationParameters ( ) const
inline

Get the ApplicationParameters.

If the element is not present, an invalid Block will be returned.

See also
hasApplicationParameters()

Definition at line 323 of file interest.hpp.

◆ getAutoCheckParametersDigest()

static bool ndn::Interest::getAutoCheckParametersDigest ( )
inlinestatic

Definition at line 441 of file interest.hpp.

◆ getCanBePrefix()

bool ndn::Interest::getCanBePrefix ( ) const
inlinenoexcept

Check whether the CanBePrefix element is present.

Definition at line 207 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()

span<const Name> ndn::Interest::getForwardingHint ( ) const
inlinenoexcept

Definition at line 243 of file interest.hpp.

◆ getHopLimit()

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

Definition at line 294 of file interest.hpp.

◆ getInterestLifetime()

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

Definition at line 282 of file interest.hpp.

◆ getMustBeFresh()

bool ndn::Interest::getMustBeFresh ( ) const
inlinenoexcept

Check whether the MustBeFresh element is present.

Definition at line 226 of file interest.hpp.

◆ getName()

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

Definition at line 173 of file interest.hpp.

◆ getNonce()

Interest::Nonce ndn::Interest::getNonce ( ) const

Get nonce value.

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

Definition at line 407 of file interest.cpp.

◆ getSignatureInfo()

optional< SignatureInfo > ndn::Interest::getSignatureInfo ( ) const

Get the InterestSignatureInfo.

Return values
nulloptInterestSignatureInfo is not present

Definition at line 549 of file interest.cpp.

◆ getSignatureValue()

Block ndn::Interest::getSignatureValue ( ) const

Get the InterestSignatureValue.

If the element is not present, an invalid Block will be returned.

Definition at line 593 of file interest.cpp.

◆ getTag()

template<typename T >
shared_ptr< T > ndn::TagHost::getTag
inherited

get a tag item

Template Parameters
Ttype of the tag, which must be a subclass of ndn::Tag
Return values
nullptrif no Tag of type T is stored

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

◆ hasApplicationParameters()

bool ndn::Interest::hasApplicationParameters ( ) const
inlinenoexcept

Return whether this Interest has any ApplicationParameters.

Definition at line 310 of file interest.hpp.

◆ hasNonce()

bool ndn::Interest::hasNonce ( ) const
inlinenoexcept

Check if the Nonce element is present.

Definition at line 254 of file interest.hpp.

◆ hasWire()

bool ndn::Interest::hasWire ( ) const
inlinenoexcept

Check if this instance has cached wire encoding.

Definition at line 140 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 678 of file interest.cpp.

◆ isSigned()

bool ndn::Interest::isSigned ( ) const
noexcept

Return whether the Interest is signed.

Warning
This function only determines whether signature information is present in the Interest and does not verify that the signature is valid.

Definition at line 539 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 330 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 362 of file interest.cpp.

◆ 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 427 of file interest.cpp.

◆ removeTag()

template<typename T >
void ndn::TagHost::removeTag
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/4]

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

Set ApplicationParameters from a Block.

Parameters
blockTLV block to be used as ApplicationParameters; must be valid
Returns
a reference to this Interest

If the block's TLV-TYPE is tlv::ApplicationParameters, it will be used directly as this Interest's ApplicationParameters element. Otherwise, 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 477 of file interest.cpp.

◆ setApplicationParameters() [2/4]

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

Set ApplicationParameters by copying from a raw buffer.

Parameters
valuepoints to a buffer from which the TLV-VALUE of the parameters will be copied; may be nullptr if length is zero
lengthsize of the buffer
Returns
a reference to this Interest
Deprecated:
Use setApplicationParameters(span<const uint8_t>)

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 504 of file interest.cpp.

◆ setApplicationParameters() [3/4]

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

Set ApplicationParameters from a shared buffer.

Parameters
valuebuffer 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 514 of file interest.cpp.

◆ setApplicationParameters() [4/4]

Interest & ndn::Interest::setApplicationParameters ( span< const uint8_t >  value)

Set ApplicationParameters by copying from a contiguous sequence of bytes.

Parameters
valuebuffer from which the TLV-VALUE of the parameters will be copied
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 495 of file interest.cpp.

◆ setAutoCheckParametersDigest()

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

Definition at line 447 of file interest.hpp.

◆ setCanBePrefix()

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

Add or remove CanBePrefix element.

Parameters
canBePrefixwhether CanBePrefix element should be present.

Definition at line 216 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 has been changed from "true" to "false". Application developers are advised to review all Interests expressed by their applications and decide what CanBePrefix setting is appropriate for each Interest. Applications must set CanBePrefix on a per-Interest basis, if different from the default value. Changing the application-wide default CanBePrefix setting via this function is deprecated.

Deprecated:
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 199 of file interest.hpp.

◆ setForwardingHint()

Interest & ndn::Interest::setForwardingHint ( std::vector< Name value)

Definition at line 390 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 454 of file interest.cpp.

◆ setInterestLifetime()

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

Set the Interest's lifetime.

Exceptions
std::invalid_argumentlifetime is negative

Definition at line 440 of file interest.cpp.

◆ setMustBeFresh()

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

Add or remove MustBeFresh element.

Parameters
mustBeFreshwhether MustBeFresh element should be present.

Definition at line 235 of file interest.hpp.

◆ setName()

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

Set the Interest's name.

Exceptions
std::invalid_argumentname is invalid

Definition at line 372 of file interest.cpp.

◆ setNonce()

Interest & ndn::Interest::setNonce ( optional< Nonce nonce)

Set the Interest's nonce.

Use setNonce(nullopt) to remove any nonce from the Interest.

Definition at line 417 of file interest.cpp.

◆ setSignatureInfo()

Interest & ndn::Interest::setSignatureInfo ( const SignatureInfo info)

Set the InterestSignatureInfo.

Definition at line 559 of file interest.cpp.

◆ setSignatureValue()

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

Set the InterestSignatureValue.

Parameters
valueBuffer containing the TLV-VALUE of the InterestSignatureValue; must not be nullptr
Exceptions
ErrorInterestSignatureInfo is unset

InterestSignatureInfo must be set before setting InterestSignatureValue

Definition at line 603 of file interest.cpp.

◆ setTag()

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

set a tag item

Template Parameters
Ttype 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 320 of file interest.cpp.

◆ unsetApplicationParameters()

Interest & ndn::Interest::unsetApplicationParameters ( )

Remove the ApplicationParameters element from this Interest.

Returns
a reference to this Interest
Postcondition
hasApplicationParameters() == false

This function will also remove any InterestSignatureInfo and InterestSignatureValue elements in the Interest, as well as any ParametersSha256DigestComponents in the Interest's name.

Definition at line 527 of file interest.cpp.

◆ wireDecode()

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

Decode from wire.

Definition at line 155 of file interest.cpp.

◆ wireEncode() [1/2]

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

Encode into a Block.

Definition at line 139 of file interest.cpp.

◆ wireEncode() [2/2]

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

Prepend wire encoding to encoder.

Definition at line 65 of file interest.cpp.