#include <interest.hpp>

Inheritance diagram for ndn::Interest:

Collaboration diagram for ndn::Interest:

Classes
class	Error

Public Member Functions
	Interest ()
	Create a new Interest with an empty name (`ndn:/`) More...

	Interest (const Name &name)
	Create a new Interest with the given name. More...

	Interest (const Name &name, const time::milliseconds &interestLifetime)
	Create a new Interest with the given name and interest lifetime. More...

	Interest (const Block &wire)
	Create from wire encoding. More...

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Fast encoding or block size estimation. More...

const Block &	wireEncode () const
	Encode to a wire format. More...

void	wireDecode (const Block &wire)
	Decode from the wire format. More...

bool	hasWire () const
	Check if already has wire. More...

std::string	toUri () const
	Encode the name according to the NDN URI Scheme. More...

bool	hasLink () const
	Check whether the Interest contains a Link object. More...

const Link &	getLink () const
	Get the link object for this interest. More...

void	setLink (const Block &link)
	Set the link object for this interest. More...

void	unsetLink ()
	Delete the link object for this interest. More...

bool	hasSelectedDelegation () const
	Check whether the Interest includes a selected delegation. More...

Name	getSelectedDelegation () const
	Get the name of the selected delegation. More...

void	setSelectedDelegation (const Name &delegationName)
	Set the selected delegation. More...

void	setSelectedDelegation (size_t delegationIndex)
	Set the selected delegation. More...

void	unsetSelectedDelegation ()
	Unset the selected delegation. More...

bool	matchesName (const Name &name) const
	Check if Interest, including selectors, matches the given `name`. More...

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

const Name &	getName () const

Interest &	setName (const Name &name)

const time::milliseconds &	getInterestLifetime () const

Interest &	setInterestLifetime (const time::milliseconds &interestLifetime)

bool	hasNonce () const
	Check if Nonce set. More...

uint32_t	getNonce () const
	Get Interest's nonce. More...

Interest &	setNonce (uint32_t nonce)
	Set Interest's nonce. More...

void	refreshNonce ()
	Refresh nonce. More...

bool	hasSelectors () const

const Selectors &	getSelectors () const

Interest &	setSelectors (const Selectors &selectors)

int	getMinSuffixComponents () const

Interest &	setMinSuffixComponents (int minSuffixComponents)

int	getMaxSuffixComponents () const

Interest &	setMaxSuffixComponents (int maxSuffixComponents)

const KeyLocator &	getPublisherPublicKeyLocator () const

Interest &	setPublisherPublicKeyLocator (const KeyLocator &keyLocator)

const Exclude &	getExclude () const

Interest &	setExclude (const Exclude &exclude)

int	getChildSelector () const

Interest &	setChildSelector (int childSelector)

int	getMustBeFresh () const

Interest &	setMustBeFresh (bool mustBeFresh)

bool	operator== (const Interest &other) const

bool	operator!= (const Interest &other) const

Public Member Functions inherited from ndn::TagHost
template<typename T >
shared_ptr< T >	getTag () const
	get a tag item More...

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

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

Detailed Description

represents an Interest packet

Definition at line 42 of file interest.hpp.

Constructor & Destructor Documentation

◆ Interest() [1/4]

ndn::Interest::Interest ( )

Create a new Interest with an empty name (ndn:/)

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, .shared_from_this() will throw an exception.

Definition at line 36 of file interest.cpp.

Referenced by ndn::Interest::Error::Error().

◆ Interest() [2/4]

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

Create a new Interest with the given name.

Parameters

name	The name for the interest.

Note: This constructor allows implicit conversion from Name.

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, .shared_from_this() will throw an exception.

Definition at line 42 of file interest.cpp.

◆ Interest() [3/4]

ndn::Interest::Interest	(	const Name &	name,
		const time::milliseconds &	interestLifetime
	)

Create a new Interest with the given name and interest lifetime.

Parameters

name	The name for the interest.
interestLifetime	The interest lifetime in time::milliseconds, or -1 for none.

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, .shared_from_this() will throw an exception.

Definition at line 49 of file interest.cpp.

◆ Interest() [4/4]

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

explicit

Create from wire encoding.

Warning: In certain contexts that use Interest::shared_from_this(), Interest must be created using make_shared. Otherwise, .shared_from_this() will throw an exception.

Definition at line 56 of file interest.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

template<encoding::Tag TAG>

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

Fast encoding or block size estimation.

Definition at line 217 of file interest.cpp.

References ndn::DEFAULT_INTEREST_LIFETIME, getInterestLifetime(), getName(), getNonce(), getSelectors(), hasLink(), hasSelectedDelegation(), hasSelectors(), ndn::tlv::Interest, ndn::tlv::InterestLifetime, ndn::encoding::prependNonNegativeIntegerBlock(), ndn::tlv::SelectedDelegation, ndn::Selectors::wireEncode(), and ndn::Name::wireEncode().

Referenced by nfd::face::GenericLinkService::GenericLinkService(), ns3::ndn::L3RateTracer::InNack(), operator==(), ns3::ndn::L3RateTracer::OutNack(), and ndn::Face::put().

◆ wireEncode() [2/2]

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

Encode to a wire format.

Definition at line 277 of file interest.cpp.

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

Referenced by ndn::Interest::Error::Error(), and operator==().

◆ wireDecode()

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

Decode from the wire format.

Definition at line 295 of file interest.cpp.

References ndn::Link::countDelegationsFromWire(), ndn::tlv::Data, ndn::DEFAULT_INTEREST_LIFETIME, ndn::Block::elements_end(), ndn::Block::find(), ndn::Block::get(), hasLink(), ndn::tlv::Interest, ndn::tlv::InterestLifetime, ndn::INVALID_SELECTED_DELEGATION_INDEX, ndn::tlv::Name, ndn::tlv::Nonce, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::SelectedDelegation, ndn::tlv::Selectors, ndn::Block::type(), ndn::Selectors::wireDecode(), and ndn::Name::wireDecode().

Referenced by ndn::Interest::Error::Error(), Interest(), and wireEncode().

◆ hasWire()

bool ndn::Interest::hasWire ( ) const

inline

Check if already has wire.

Definition at line 107 of file interest.hpp.

References getLink(), getSelectedDelegation(), hasLink(), hasSelectedDelegation(), matchesData(), matchesName(), setLink(), setSelectedDelegation(), toUri(), unsetLink(), and unsetSelectedDelegation().

Referenced by ns3::ndn::L3RateTracer::InNack(), and ns3::ndn::L3RateTracer::OutNack().

◆ toUri()

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

inline

Encode the name according to the NDN URI Scheme.

If there are interest selectors, this method will append "?" and add the selectors as a query string. For example, "/test/name?ndn.ChildSelector=1"

Definition at line 412 of file interest.hpp.

Referenced by hasWire().

◆ hasLink()

bool ndn::Interest::hasLink ( ) const

Check whether the Interest contains a Link object.

Returns: True if there is a link object, otherwise false

Definition at line 364 of file interest.cpp.

References ndn::Block::hasWire().

Referenced by getLink(), hasWire(), nfd::fw::Strategy::lookupFib(), nfd::Forwarder::startProcessInterest(), nfd::Forwarder::startProcessNack(), wireDecode(), and wireEncode().

◆ getLink()

const Link & ndn::Interest::getLink ( ) const

Get the link object for this interest.

Returns: The link object if there is one contained in this interest

Exceptions

Interest::Error	if there is no link object contained in the interest
tlv::Error	if the incorporated link object is malformed

Definition at line 370 of file interest.cpp.

References hasLink().

Referenced by hasWire(), nfd::fw::Strategy::lookupFib(), nfd::Forwarder::startProcessInterest(), and nfd::Forwarder::startProcessNack().

◆ setLink()

void ndn::Interest::setLink ( const Block & link )

Set the link object for this interest.

Parameters

link	The link object that will be included in this interest (in wire format)

Postcondition: !hasSelectedDelegation()

Definition at line 382 of file interest.cpp.

References ndn::Block::hasWire(), ndn::Block::reset(), and unsetSelectedDelegation().

Referenced by hasWire().

◆ unsetLink()

void ndn::Interest::unsetLink ( )

Delete the link object for this interest.

Postcondition: !hasLink()

Definition at line 394 of file interest.cpp.

References ndn::Block::reset(), and unsetSelectedDelegation().

Referenced by hasWire().

◆ hasSelectedDelegation()

bool ndn::Interest::hasSelectedDelegation ( ) const

Check whether the Interest includes a selected delegation.

Returns: True if there is a selected delegation, otherwise false

Definition at line 403 of file interest.cpp.

References ndn::INVALID_SELECTED_DELEGATION_INDEX.

Referenced by getSelectedDelegation(), hasWire(), nfd::fw::Strategy::lookupFib(), and wireEncode().

◆ getSelectedDelegation()

Name ndn::Interest::getSelectedDelegation ( ) const

Get the name of the selected delegation.

Returns: The name of the selected delegation

Exceptions

Error SelectedDelegation is not set.

Definition at line 409 of file interest.cpp.

References ndn::Link::getDelegationFromWire(), and hasSelectedDelegation().

Referenced by hasWire(), and nfd::fw::Strategy::lookupFib().

◆ setSelectedDelegation() [1/2]

void ndn::Interest::setSelectedDelegation ( const Name & delegationName )

Set the selected delegation.

Parameters

delegationName The name of the selected delegation

Exceptions

Error	Link is not set.
std::invalid_argument	`delegationName` does not exist in Link.

Definition at line 418 of file interest.cpp.

References ndn::Link::findDelegationFromWire(), ndn::INVALID_SELECTED_DELEGATION_INDEX, and ndn::Block::reset().

Referenced by hasWire().

◆ setSelectedDelegation() [2/2]

void ndn::Interest::setSelectedDelegation ( size_t delegationIndex )

Set the selected delegation.

Parameters

delegationIndex The index of the selected delegation

Exceptions

Error	Link is not set.
std::out_of_range	`delegationIndex` is out of bound in Link.

Definition at line 431 of file interest.cpp.

References ndn::Block::reset().

◆ unsetSelectedDelegation()

void ndn::Interest::unsetSelectedDelegation ( )

Unset the selected delegation.

Definition at line 441 of file interest.cpp.

References ndn::INVALID_SELECTED_DELEGATION_INDEX, and ndn::Block::reset().

Referenced by hasWire(), setLink(), and unsetLink().

◆ matchesName()

bool ndn::Interest::matchesName ( const Name & name ) const

Check if Interest, including selectors, matches the given name.

Parameters

name	The name to be matched. If this is a Data name, it shall contain the implicit digest component

Definition at line 105 of file interest.cpp.

References ndn::Exclude::empty(), getExclude(), getMaxSuffixComponents(), getMinSuffixComponents(), ndn::Exclude::isExcluded(), ndn::Name::isPrefixOf(), and ndn::Name::size().

Referenced by hasWire().

◆ matchesData()

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

Check if Interest can be satisfied by data.

This method considers Name, MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. This method does not consider ChildSelector and MustBeFresh.

Todo:: recognize implicit digest component

Definition at line 132 of file interest.cpp.

References ndn::Block::elements_end(), ndn::KeyLocator::empty(), ndn::Exclude::empty(), ndn::Block::find(), ndn::Name::get(), getExclude(), ndn::Data::getFullName(), ndn::Signature::getInfo(), getMaxSuffixComponents(), getMinSuffixComponents(), ndn::Data::getName(), getPublisherPublicKeyLocator(), ndn::Data::getSignature(), ndn::Exclude::isExcluded(), ndn::name::Component::isImplicitSha256Digest(), ndn::Name::isPrefixOf(), ndn::tlv::KeyLocator, ndn::Name::size(), and ndn::KeyLocator::wireEncode().

Referenced by nfd::cs::Entry::canSatisfy(), hasWire(), and ndn::util::InMemoryStorage::selectChild().

◆ getName()

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

inline

Definition at line 215 of file interest.hpp.

Referenced by ndn::mgmt::Dispatcher::addStatusDataset(), nfd::fw::asf::AsfStrategy::afterReceiveNack(), nfd::pit::Entry::canMatch(), ndn::security::conf::KeyLocatorChecker::check(), ndn::security::conf::CustomizedChecker::check(), ndn::security::conf::FixedSignerChecker::check(), ndn::security::ValidatorConfig::checkPolicy(), ndn::security::CommandInterestValidator::checkPolicy(), ndn::util::DummyClientFace::DummyClientFace(), nfd::ManagerBase::extractRequester(), ndn::util::SegmentFetcher::fetch(), nfd::cs::Cs::find(), ndn::util::InMemoryStorage::find(), ndn::security::KeyChain::getDefaultKeyParamsForIdentity(), nfd::fw::asf::AsfMeasurements::getOrCreateNamespaceInfo(), nfd::CommandAuthenticator::makeAuthorization(), ndn::security::conf::Filter::match(), ndn::security::Validator::onNack(), ndn::security::Validator::onTimeout(), ndn::operator<<(), nfd::pit::Pit::Pit(), ndn::mgmt::Dispatcher::removeTopPrefix(), ndn::util::InMemoryStorage::selectChild(), nfd::FaceManager::setConfigFile(), ndn::mgmt::StatusDatasetContext::setPrefix(), ndn::security::KeyChain::signWithSha256(), nfd::Forwarder::startProcessInterest(), nfd::Forwarder::startProcessNack(), ndn::mgmt::StatusDatasetContext::StatusDatasetContext(), ndn::security::Validator::verifySignature(), wireEncode(), and nfd::fw::wouldViolateScope().

◆ setName()

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

inline

Definition at line 221 of file interest.hpp.

Referenced by ndn::util::SegmentFetcher::fetch(), ndn::security::KeyChain::getDefaultKeyParamsForIdentity(), and ndn::security::KeyChain::signWithSha256().

◆ getInterestLifetime()

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

inline

Definition at line 229 of file interest.hpp.

Referenced by ndn::operator<<(), nfd::pit::FaceRecord::update(), and wireEncode().

◆ setInterestLifetime()

Interest& ndn::Interest::setInterestLifetime ( const time::milliseconds & interestLifetime )

inline

Definition at line 235 of file interest.hpp.

Referenced by ndn::nfd::Controller::Controller().

◆ hasNonce()

bool ndn::Interest::hasNonce ( ) const

inline

Check if Nonce set.

Definition at line 245 of file interest.hpp.

References getNonce(), refreshNonce(), and setNonce().

Referenced by ndn::util::SegmentFetcher::fetch(), ndn::operator<<(), and refreshNonce().

◆ getNonce()

uint32_t ndn::Interest::getNonce ( ) const

Get Interest's nonce.

If nonce was not set before this call, it will be automatically assigned to a random value

Definition at line 62 of file interest.cpp.

References ndn::random::generateWord32(), ndn::Block::hasWire(), ndn::encoding::readNonNegativeInteger(), ndn::Block::value(), and ndn::Block::value_size().

Referenced by hasNonce(), ndn::operator<<(), refreshNonce(), nfd::pit::OutRecord::setIncomingNack(), nfd::Forwarder::startProcessNack(), nfd::pit::FaceRecord::update(), and wireEncode().

◆ setNonce()

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

Set Interest's nonce.

If wire format already exists, this call simply replaces nonce in the existing wire format, without resetting and recreating it.

Definition at line 76 of file interest.cpp.

References ndn::Block::hasWire(), ndn::encoding::makeBinaryBlock(), ndn::tlv::Nonce, ndn::Block::reset(), ndn::Block::value(), and ndn::Block::value_size().

Referenced by nfd::fw::Strategy::afterReceiveNack(), hasNonce(), and refreshNonce().

◆ refreshNonce()

void ndn::Interest::refreshNonce ( )

Refresh nonce.

It's guaranteed that new nonce value differs from the existing one.

If nonce is already set, it will be updated to a different random value. If nonce is not set, this method does nothing.

Definition at line 91 of file interest.cpp.

References ndn::random::generateWord32(), getNonce(), hasNonce(), and setNonce().

Referenced by ndn::util::SegmentFetcher::fetch(), hasNonce(), ndn::security::Validator::onNack(), and ndn::security::Validator::onTimeout().

◆ hasSelectors()

bool ndn::Interest::hasSelectors ( ) const

inline

Returns: true if Interest has any selector present

Definition at line 280 of file interest.hpp.

Referenced by wireEncode().

◆ getSelectors()

const Selectors& ndn::Interest::getSelectors ( ) const

inline

Definition at line 286 of file interest.hpp.

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

◆ setSelectors()

Interest& ndn::Interest::setSelectors ( const Selectors & selectors )

inline

Definition at line 292 of file interest.hpp.

◆ getMinSuffixComponents()

int ndn::Interest::getMinSuffixComponents ( ) const

inline

Definition at line 300 of file interest.hpp.

Referenced by matchesData(), matchesName(), and ndn::operator<<().

◆ setMinSuffixComponents()

Interest& ndn::Interest::setMinSuffixComponents ( int minSuffixComponents )

inline

Definition at line 306 of file interest.hpp.

References setMinSuffixComponents().

Referenced by setMinSuffixComponents().

◆ getMaxSuffixComponents()

int ndn::Interest::getMaxSuffixComponents ( ) const

inline

Definition at line 314 of file interest.hpp.

Referenced by matchesData(), matchesName(), and ndn::operator<<().

◆ setMaxSuffixComponents()

Interest& ndn::Interest::setMaxSuffixComponents ( int maxSuffixComponents )

inline

Definition at line 320 of file interest.hpp.

References setMaxSuffixComponents().

Referenced by setMaxSuffixComponents().

◆ getPublisherPublicKeyLocator()

const KeyLocator& ndn::Interest::getPublisherPublicKeyLocator ( ) const

inline

Definition at line 328 of file interest.hpp.

Referenced by matchesData().

◆ setPublisherPublicKeyLocator()

Interest& ndn::Interest::setPublisherPublicKeyLocator ( const KeyLocator & keyLocator )

inline

Definition at line 334 of file interest.hpp.

References setPublisherPublicKeyLocator().

Referenced by setPublisherPublicKeyLocator().

◆ getExclude()

const Exclude& ndn::Interest::getExclude ( ) const

inline

Definition at line 342 of file interest.hpp.

Referenced by matchesData(), matchesName(), and ndn::operator<<().

◆ setExclude()

Interest& ndn::Interest::setExclude ( const Exclude & exclude )

inline

Definition at line 348 of file interest.hpp.

References setExclude().

Referenced by setExclude().

◆ getChildSelector()

int ndn::Interest::getChildSelector ( ) const

inline

Definition at line 356 of file interest.hpp.

Referenced by nfd::cs::Cs::find(), ndn::operator<<(), and ndn::util::InMemoryStorage::selectChild().

◆ setChildSelector()

Interest& ndn::Interest::setChildSelector ( int childSelector )

inline

Definition at line 362 of file interest.hpp.

References setChildSelector().

Referenced by ndn::util::SegmentFetcher::fetch(), and setChildSelector().

◆ getMustBeFresh()

int ndn::Interest::getMustBeFresh ( ) const

inline

Definition at line 370 of file interest.hpp.

Referenced by nfd::cs::Entry::canSatisfy(), nfd::insertNonceToDnl(), ndn::operator<<(), and ndn::util::InMemoryStorage::selectChild().

◆ setMustBeFresh()

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

inline

Definition at line 376 of file interest.hpp.

References setMustBeFresh().

Referenced by ndn::util::SegmentFetcher::fetch(), and setMustBeFresh().

◆ operator==()

bool ndn::Interest::operator== ( const Interest & other ) const

inline

Definition at line 385 of file interest.hpp.

References wireEncode().

◆ operator!=()

bool ndn::Interest::operator!= ( const Interest & other ) const

inline

Definition at line 391 of file interest.hpp.

References ndn::operator<<().

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

ndnSIM/ndn-cxx/src/interest.hpp
ndnSIM/ndn-cxx/src/interest.cpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Interest() [1/4]

◆ Interest() [2/4]

◆ Interest() [3/4]

◆ Interest() [4/4]

Member Function Documentation

◆ wireEncode() [1/2]

◆ wireEncode() [2/2]

◆ wireDecode()

◆ hasWire()

◆ toUri()

◆ hasLink()

◆ getLink()

◆ setLink()

◆ unsetLink()

◆ hasSelectedDelegation()

◆ getSelectedDelegation()

◆ setSelectedDelegation() [1/2]

◆ setSelectedDelegation() [2/2]

◆ unsetSelectedDelegation()

◆ matchesName()

◆ matchesData()

◆ getName()

◆ setName()

◆ getInterestLifetime()

◆ setInterestLifetime()

◆ hasNonce()

◆ getNonce()

◆ setNonce()

◆ refreshNonce()

◆ hasSelectors()

◆ getSelectors()

◆ setSelectors()

◆ getMinSuffixComponents()

◆ setMinSuffixComponents()

◆ getMaxSuffixComponents()

◆ setMaxSuffixComponents()

◆ getPublisherPublicKeyLocator()

◆ setPublisherPublicKeyLocator()

◆ getExclude()

◆ setExclude()

◆ getChildSelector()

◆ setChildSelector()

◆ getMustBeFresh()

◆ setMustBeFresh()

◆ operator==()

◆ operator!=()