NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Types | Public Member Functions | Friends | List of all members
ndn::KeyLocator Class Reference

#include <key-locator.hpp>

Classes

class  Error
 

Public Types

enum  Type { KeyLocator_None = tlv::Invalid, KeyLocator_Name = tlv::Name, KeyLocator_KeyDigest = tlv::KeyDigest }
 

Public Member Functions

 KeyLocator ()
 Construct an empty KeyLocator. More...
 
 KeyLocator (const Name &name)
 Construct from Name. More...
 
 KeyLocator (const Block &wire)
 Construct from wire encoding. More...
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 Prepend wire encoding to encoder. More...
 
const Block & wireEncode () const
 
void wireDecode (const Block &wire)
 Decode from wire encoding. More...
 
NDN_CXX_NODISCARD bool empty () const
 
uint32_t getType () const
 
KeyLocator & clear ()
 Reset KeyLocator to its default-constructed state. More...
 
const Name & getName () const
 Get nested Name element. More...
 
KeyLocator & setName (const Name &name)
 Set nested Name element. More...
 
const Block & getKeyDigest () const
 Get nested KeyDigest element. More...
 
KeyLocator & setKeyDigest (const Block &keyDigest)
 Set nested KeyDigest element (whole TLV). More...
 
KeyLocator & setKeyDigest (const ConstBufferPtr &keyDigest)
 Set nested KeyDigest element value. More...
 

Friends

bool operator== (const KeyLocator &lhs, const KeyLocator &rhs)
 
bool operator!= (const KeyLocator &lhs, const KeyLocator &rhs)
 
std::ostream & operator<< (std::ostream &, const KeyLocator &)
 

Detailed Description

Definition at line 29 of file key-locator.hpp.

Member Enumeration Documentation

◆ Type

enum ndn::KeyLocator::Type
Enumerator
KeyLocator_None 

KeyLocator is empty.

KeyLocator_Name 

KeyLocator contains a Name.

KeyLocator_KeyDigest 

KeyLocator contains a KeyDigest.

Definition at line 38 of file key-locator.hpp.

Constructor & Destructor Documentation

◆ KeyLocator() [1/3]

ndn::KeyLocator::KeyLocator ( )
default

Construct an empty KeyLocator.

Postcondition
empty() == true

◆ KeyLocator() [2/3]

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

Construct from Name.

Note
Implicit conversion is permitted.
Postcondition
getType() == tlv::Name

Definition at line 45 of file key-locator.cpp.

◆ KeyLocator() [3/3]

ndn::KeyLocator::KeyLocator ( const Block &  wire)
explicit

Construct from wire encoding.

Definition at line 40 of file key-locator.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/2]

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

Prepend wire encoding to encoder.

Definition at line 52 of file key-locator.cpp.

References ndn::tlv::KeyLocator, NDN_THROW, ndn::overload, ndn::to_string(), and nonstd::variants::visit().

Referenced by ndn::SignatureInfo::wireEncode().

◆ wireEncode() [2/2]

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

Definition at line 74 of file key-locator.cpp.

References ndn::Block::hasWire().

◆ wireDecode()

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

Decode from wire encoding.

Exceptions
Errorouter TLV type is not KeyLocator
Note
No error is raised for an unrecognized nested TLV, but attempting to reencode will throw.

Definition at line 90 of file key-locator.cpp.

References clear(), ndn::Block::elements(), ndn::Block::elements_begin(), ndn::tlv::KeyDigest, ndn::tlv::KeyLocator, ndn::tlv::Name, NDN_THROW, ndn::Block::parse(), and ndn::Block::type().

Referenced by KeyLocator(), and ndn::SignatureInfo::wireDecode().

◆ empty()

NDN_CXX_NODISCARD bool ndn::KeyLocator::empty ( ) const
inline

Definition at line 87 of file key-locator.hpp.

◆ getType()

uint32_t ndn::KeyLocator::getType ( ) const

Definition at line 118 of file key-locator.cpp.

References ndn::tlv::Invalid, ndn::tlv::KeyDigest, ndn::tlv::Name, and NDN_CXX_UNREACHABLE.

Referenced by nfd::ManagerBase::extractRequester(), and ndn::security::v2::getKeyLocatorName().

◆ clear()

KeyLocator & ndn::KeyLocator::clear ( )

Reset KeyLocator to its default-constructed state.

Postcondition
empty() == true
getType() == tlv::Invalid
Returns
self

Definition at line 135 of file key-locator.cpp.

References ndn::Block::reset().

Referenced by wireDecode().

◆ getName()

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

Get nested Name element.

Exceptions
Errorif type is not tlv::Name

Definition at line 143 of file key-locator.cpp.

References NDN_THROW.

Referenced by nfd::ManagerBase::extractRequester(), and ndn::security::v2::getKeyLocatorName().

◆ setName()

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

Set nested Name element.

Postcondition
getType() == tlv::Name
Returns
self

Definition at line 154 of file key-locator.cpp.

References ndn::Block::reset().

◆ getKeyDigest()

const Block & ndn::KeyLocator::getKeyDigest ( ) const

Get nested KeyDigest element.

Exceptions
Errorif type is not tlv::KeyDigest

Definition at line 162 of file key-locator.cpp.

References NDN_THROW.

◆ setKeyDigest() [1/2]

KeyLocator & ndn::KeyLocator::setKeyDigest ( const Block &  keyDigest)

Set nested KeyDigest element (whole TLV).

Postcondition
getType() == tlv::KeyDigest
Exceptions
std::invalid_argumentBlock type is not tlv::KeyDigest
Returns
self

Definition at line 173 of file key-locator.cpp.

References ndn::tlv::KeyDigest, NDN_THROW, ndn::Block::reset(), ndn::to_string(), and ndn::Block::type().

◆ setKeyDigest() [2/2]

KeyLocator & ndn::KeyLocator::setKeyDigest ( const ConstBufferPtr &  keyDigest)

Set nested KeyDigest element value.

Parameters
keyDigestbuffer to use as TLV-VALUE of the nested KeyDigest element.
Postcondition
getType() == tlv::KeyDigest
Returns
self

Definition at line 184 of file key-locator.cpp.

References ndn::tlv::KeyDigest, ndn::encoding::makeBinaryBlock(), and ndn::Block::reset().

Friends And Related Function Documentation

◆ operator==

bool operator== ( const KeyLocator &  lhs,
const KeyLocator &  rhs 
)
friend

Definition at line 143 of file key-locator.hpp.

◆ operator!=

bool operator!= ( const KeyLocator &  lhs,
const KeyLocator &  rhs 
)
friend

Definition at line 149 of file key-locator.hpp.

◆ operator<<

std::ostream& operator<< ( std::ostream &  ,
const KeyLocator &   
)
friend

Definition at line 192 of file key-locator.cpp.

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