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

Represents a Data packet. More...

#include <data.hpp>

Inheritance diagram for ndn::Data:
Collaboration diagram for ndn::Data:

Classes

class  Error
 

Public Member Functions

 Data (const Name &name=Name())
 Create a new Data with the given name and empty Content. More...
 
 Data (const Block &wire)
 Create from wire encoding. More...
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder, bool wantUnsignedPortionOnly=false) const
 Fast encoding or block size estimation. More...
 
const BlockwireEncode (EncodingBuffer &encoder, const Block &signatureValue) const
 Finalize Data packet encoding with the specified SignatureValue. More...
 
const BlockwireEncode () 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...
 
const NamegetFullName () const
 Get full name including implicit digest. More...
 
const NamegetName () const
 Get name. More...
 
DatasetName (const Name &name)
 Set name. More...
 
const MetaInfogetMetaInfo () const
 Get MetaInfo. More...
 
DatasetMetaInfo (const MetaInfo &metaInfo)
 Set MetaInfo. More...
 
const BlockgetContent () const
 Get Content. More...
 
DatasetContent (const Block &block)
 Set Content from a block. More...
 
DatasetContent (const uint8_t *value, size_t valueSize)
 Copy Content value from raw buffer. More...
 
DatasetContent (const ConstBufferPtr &value)
 Set Content from wire buffer. More...
 
const SignaturegetSignature () const
 Get Signature. More...
 
DatasetSignature (const Signature &signature)
 Set Signature. More...
 
DatasetSignatureValue (const Block &value)
 Set SignatureValue. More...
 
uint32_t getContentType () const
 
DatasetContentType (uint32_t type)
 
const time::milliseconds & getFreshnessPeriod () const
 
DatasetFreshnessPeriod (const time::milliseconds &freshnessPeriod)
 
const name::ComponentgetFinalBlockId () const
 
DatasetFinalBlockId (const name::Component &finalBlockId)
 
- Public Member Functions inherited from ndn::PacketBase
uint64_t getCongestionMark () const
 get the value of the CongestionMark tag More...
 
void setCongestionMark (uint64_t mark)
 set the CongestionMark tag to the specified value More...
 
- 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...
 

Protected Member Functions

void resetWire ()
 Clear wire encoding and cached FullName. More...
 

Detailed Description

Represents a Data packet.

Definition at line 35 of file data.hpp.

Constructor & Destructor Documentation

ndn::Data::Data ( const Name name = Name())
explicit

Create a new Data with the given name and empty Content.

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

Definition at line 35 of file data.cpp.

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

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

Create from wire encoding.

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

Definition at line 41 of file data.cpp.

References wireDecode().

Member Function Documentation

template<encoding::Tag TAG>
size_t ndn::Data::wireEncode ( EncodingImpl< TAG > &  encoder,
bool  wantUnsignedPortionOnly = false 
) const

Fast encoding or block size estimation.

Parameters
encoderEncodingEstimator or EncodingBuffer instance
wantUnsignedPortionOnlyIf true, only prepends Name, MetaInfo, Content, and SignatureInfo to encoder, but omit SignatureValue and outmost Type-Length of Data element. This is intended to be used with wireEncode(encoder, signatureValue).
Exceptions
ErrorSignatureBits are not provided and wantUnsignedPortionOnly is false.

Definition at line 48 of file data.cpp.

References ndn::tlv::Data, getContent(), ndn::Signature::getInfo(), getMetaInfo(), getName(), ndn::Signature::getValue(), ndn::MetaInfo::wireEncode(), and ndn::Name::wireEncode().

Referenced by ndn::security::pib::PibSqlite3::addCertificate(), ndn::security::pib::detail::KeyImpl::getDefaultCertificate(), ndn::security::parse(), ndn::util::DummyClientFace::receive(), nfd::face::GenericLinkService::setOptions(), ndn::security::v2::KeyChain::sign(), and ndn::security::SafeBag::wireEncode().

const Block & ndn::Data::wireEncode ( EncodingBuffer &  encoder,
const Block signatureValue 
) const

Finalize Data packet encoding with the specified SignatureValue.

Parameters
encoderEncodingBuffer containing Name, MetaInfo, Content, and SignatureInfo, but without SignatureValue or outmost Type-Length of Data element
signatureValueSignatureValue element

This method is intended to be used in concert with Data::wireEncode(encoder, true)

Data data;
...
EncodingBuffer encoder;
data.wireEncode(encoder, true);
...
Block signatureValue = <sign_over_unsigned_portion>(encoder.buf(), encoder.size());
data.wireEncode(encoder, signatureValue)

Definition at line 93 of file data.cpp.

References ndn::tlv::Data, ndn::Block::size(), and wireDecode().

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

Encode to a wire format.

Definition at line 106 of file data.cpp.

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

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

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

Check if already has wire.

Definition at line 105 of file data.hpp.

References getFullName().

const Name & ndn::Data::getFullName ( ) const
const Name& ndn::Data::getName ( ) const
inline

Get name.

Definition at line 121 of file data.hpp.

References setName().

Referenced by ndn::security::pib::CertificateContainer::add(), ndn::security::pib::PibMemory::addCertificate(), ndn::security::pib::PibSqlite3::addCertificate(), ndn::security::v2::KeyChain::addCertificate(), nfd::fw::asf::AsfStrategy::beforeSatisfyInterest(), nfd::fw::AccessStrategy::beforeSatisfyInterest(), nfd::fw::Strategy::beforeSatisfyInterest(), ndn::security::v2::Certificate::Certificate(), ndn::security::v2::ValidationPolicySimpleHierarchy::checkPolicy(), ndn::security::v2::validator_config::ValidationPolicyConfig::checkPolicy(), nfd::cs::compareDataWithData(), nfd::cs::compareQueryWithData(), ndn::security::v2::CertificateFetcherFromNetwork::doFetch(), ndn::security::v2::CertificateBundleFetcher::doFetch(), ndn::util::SegmentFetcher::fetch(), nfd::pit::Pit::findAllDataMatches(), nfd::Forwarder::Forwarder(), ndn::security::v2::Certificate::getIdentity(), ndn::security::v2::Certificate::getIssuerId(), ndn::security::v2::Certificate::getKeyId(), ndn::security::v2::Certificate::getKeyName(), ndn::security::v2::KeyChain::importSafeBag(), ndn::security::v2::CertificateCache::insert(), nfd::cs::Cs::insert(), ndn::Interest::matchesData(), ndn::security::v2::operator<<(), ndn::operator<<(), ndn::operator==(), ndn::Face::put(), ndn::security::pib::detail::KeyImpl::removeCertificate(), ndn::security::pib::detail::KeyImpl::setDefaultCertificate(), ndn::security::v2::KeyChain::setDefaultCertificate(), ndn::security::signingByCertificate(), ndn::util::NotificationSubscriberBase::stop(), ndn::security::v2::Validator::validate(), wireEncode(), and ndn::security::v2::DataValidationState::~DataValidationState().

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

Set name.

Returns
a reference to this Data, to allow chaining

Definition at line 169 of file data.cpp.

References resetWire().

Referenced by getName(), and ndn::security::v2::parseLocatorUri().

const MetaInfo& ndn::Data::getMetaInfo ( ) const
inline
Data & ndn::Data::setMetaInfo ( const MetaInfo metaInfo)

Set MetaInfo.

Returns
a reference to this Data, to allow chaining

Definition at line 177 of file data.cpp.

References resetWire().

Referenced by getMetaInfo().

Data & ndn::Data::setContent ( const Block block)

Set Content from a block.

If block's TLV-TYPE is Content, it will be used directly as Data's Content element. If block's TLV-TYPE is not Content, it will be nested into a Content element.

Returns
a reference to this Data, to allow chaining

Definition at line 194 of file data.cpp.

References ndn::tlv::Content, resetWire(), and ndn::Block::type().

Referenced by getMetaInfo(), ndn::Link::Link(), and ndn::security::v2::parseLocatorUri().

Data & ndn::Data::setContent ( const uint8_t *  value,
size_t  valueSize 
)

Copy Content value from raw buffer.

Parameters
valuepointer to the first octet of the value
valueSizesize of the raw buffer
Returns
a reference to this Data, to allow chaining

Definition at line 209 of file data.cpp.

References ndn::tlv::Content, ndn::encoding::makeBinaryBlock(), and resetWire().

Data & ndn::Data::setContent ( const ConstBufferPtr value)

Set Content from wire buffer.

Parameters
valueContent value, which does not need to be a TLV element
Returns
a reference to this Data, to allow chaining

Definition at line 217 of file data.cpp.

References ndn::tlv::Content, and resetWire().

Data & ndn::Data::setSignature ( const Signature signature)

Set Signature.

Returns
a reference to this Data, to allow chaining

Definition at line 225 of file data.cpp.

References resetWire().

Referenced by getSignature(), and ndn::security::v2::KeyChain::sign().

Data & ndn::Data::setSignatureValue ( const Block value)

Set SignatureValue.

Returns
a reference to this Data, to allow chaining

Definition at line 233 of file data.cpp.

References resetWire(), and ndn::Signature::setValue().

Referenced by getSignature().

uint32_t ndn::Data::getContentType ( ) const
inline
Data & ndn::Data::setContentType ( uint32_t  type)
const time::milliseconds& ndn::Data::getFreshnessPeriod ( ) const
inline
Data & ndn::Data::setFreshnessPeriod ( const time::milliseconds &  freshnessPeriod)
const name::Component& ndn::Data::getFinalBlockId ( ) const
inline

Definition at line 219 of file data.hpp.

References ndn::operator<<(), ndn::operator==(), resetWire(), and setFinalBlockId().

Data & ndn::Data::setFinalBlockId ( const name::Component finalBlockId)

Definition at line 257 of file data.cpp.

References resetWire(), and ndn::MetaInfo::setFinalBlockId().

Referenced by getFinalBlockId().

void ndn::Data::resetWire ( )
protected

Clear wire encoding and cached FullName.

Note
This does not clear the SignatureValue.

Definition at line 162 of file data.cpp.

References ndn::Name::clear(), and ndn::Block::reset().

Referenced by getFinalBlockId(), setContent(), setContentType(), setFinalBlockId(), setFreshnessPeriod(), setMetaInfo(), setName(), setSignature(), and setSignatureValue().


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