ndn::security::v2::AdditionalDescription Class Reference

Abstraction of AdditionalDescription. More...

#include <additional-description.hpp>

Classes
class	Error

Public Types
typedef std::map< std::string, std::string >::iterator	iterator
typedef std::map< std::string, std::string >::const_iterator	const_iterator

Public Member Functions
	AdditionalDescription ()=default
	Create an empty AdditionalDescription. More...
	AdditionalDescription (const Block &block)
	Create AdditionalDescription from block. More...
const std::string &	get (const std::string &key) const
void	set (const std::string &key, const std::string &value)
bool	has (const std::string &key) const
size_t	size () const
bool	empty () const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const
	Fast encoding or block size estimation. More...
const Block &	wireEncode () const
	Encode ValidityPeriod into TLV block. More...
void	wireDecode (const Block &wire)
	Decode ValidityPeriod from TLV block. More...
bool	operator== (const AdditionalDescription &other) const
bool	operator!= (const AdditionalDescription &other) const

Detailed Description

Abstraction of AdditionalDescription.

See also

docs/tutorials/certificate-format.rst

Definition at line 38 of file additional-description.hpp.

Member Typedef Documentation

typedef std::map<std::string, std::string>::iterator ndn::security::v2::AdditionalDescription::iterator

Definition at line 51 of file additional-description.hpp.

typedef std::map<std::string, std::string>::const_iterator ndn::security::v2::AdditionalDescription::const_iterator

Definition at line 52 of file additional-description.hpp.

Constructor & Destructor Documentation

ndn::security::v2::AdditionalDescription::AdditionalDescription ( )

default

Create an empty AdditionalDescription.

ndn::security::v2::AdditionalDescription::AdditionalDescription ( const Block &  block )

explicit

Create AdditionalDescription from block.

Definition at line 40 of file additional-description.cpp.

References wireDecode().

Member Function Documentation

const std::string & ndn::security::v2::AdditionalDescription::get

(

const std::string &

key

)

const

Definition at line 46 of file additional-description.cpp.

void ndn::security::v2::AdditionalDescription::set	(	const std::string &	key,
		const std::string &	value
	)

Definition at line 56 of file additional-description.cpp.

bool ndn::security::v2::AdditionalDescription::has

(

const std::string &

key

)

const

Definition at line 62 of file additional-description.cpp.

size_t ndn::security::v2::AdditionalDescription::size ( ) const

inline

Definition at line 76 of file additional-description.hpp.

bool ndn::security::v2::AdditionalDescription::empty ( ) const

inline

Definition at line 82 of file additional-description.hpp.

References ndn::tlv::AdditionalDescription, begin(), end(), ndn::security::v2::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(), operator!=(), ndn::security::v2::operator<<(), operator==(), wireDecode(), and wireEncode().

AdditionalDescription::iterator ndn::security::v2::AdditionalDescription::begin

(

)

Definition at line 68 of file additional-description.cpp.

Referenced by empty().

AdditionalDescription::iterator ndn::security::v2::AdditionalDescription::end

(

)

Definition at line 74 of file additional-description.cpp.

Referenced by empty().

AdditionalDescription::const_iterator ndn::security::v2::AdditionalDescription::begin

(

)

const

Definition at line 80 of file additional-description.cpp.

AdditionalDescription::const_iterator ndn::security::v2::AdditionalDescription::end

(

)

const

Definition at line 86 of file additional-description.cpp.

template<encoding::Tag TAG>

size_t ndn::security::v2::AdditionalDescription::wireEncode

(

EncodingImpl< TAG > &

encoder

)

const

Fast encoding or block size estimation.

Definition at line 93 of file additional-description.cpp.

References ndn::tlv::AdditionalDescription, ndn::tlv::DescriptionEntry, ndn::tlv::DescriptionKey, ndn::tlv::DescriptionValue, ndn::security::v2::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), and ndn::encoding::prependStringBlock().

const Block & ndn::security::v2::AdditionalDescription::wireEncode

(

)

const

Encode ValidityPeriod into TLV block.

Definition at line 115 of file additional-description.cpp.

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

Referenced by empty().

void ndn::security::v2::AdditionalDescription::wireDecode

(

const Block &

wire

)

Decode ValidityPeriod from TLV block.

Exceptions

Error

when an invalid TLV block supplied

Definition at line 133 of file additional-description.cpp.

References ndn::tlv::AdditionalDescription, ndn::tlv::DescriptionEntry, ndn::tlv::DescriptionKey, ndn::tlv::DescriptionValue, ndn::Block::elements(), ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::Block::elements_size(), ndn::Block::hasWire(), ndn::security::v2::KEY_OFFSET, ndn::Block::parse(), ndn::encoding::readString(), ndn::Block::type(), and ndn::security::v2::VALUE_OFFSET.

Referenced by AdditionalDescription(), and empty().

bool ndn::security::v2::AdditionalDescription::operator==

(

const AdditionalDescription &

other

)

const

Definition at line 166 of file additional-description.cpp.

Referenced by empty().

bool ndn::security::v2::AdditionalDescription::operator!=

(

const AdditionalDescription &

other

)

const

Definition at line 172 of file additional-description.cpp.

Referenced by empty().

---

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

• ndnSIM/ndn-cxx/src/security/v2/additional-description.hpp
• ndnSIM/ndn-cxx/src/security/v2/additional-description.cpp