Public Member Functions
void	clear ()
	Clear the keyData and set the type to none.

void	get (struct ndn_KeyLocator &keyLocatorStruct) const
	Set the keyLocatorStruct to point to the values in this key locator, without copying any memory. More...

void	set (const struct ndn_KeyLocator &keyLocatorStruct)
	Clear this key locator, and set the values by copying from the ndn_KeyLocator struct. More...

ndn_KeyLocatorType	getType () const

const Blob &	getKeyData () const

const Name &	getKeyName () const

Name &	getKeyName ()

ndn_KeyNameType DEPRECATED_IN_NDN_CPP	getKeyNameType () const

void	setType (ndn_KeyLocatorType type)

void	setKeyData (const Blob &keyData)

void	setKeyName (const Name &keyName)

void DEPRECATED_IN_NDN_CPP	setKeyNameType (ndn_KeyNameType keyNameType)

uint64_t	getChangeCount () const
	Get the change count, which is incremented each time this object (or a child object) is changed. More...

Static Public Member Functions
static bool	canGetFromSignature (const Signature *signature)
	If the signature is a type that has a KeyLocator (so that getFromSignature will succeed), return true. More...

static const KeyLocator &	getFromSignature (const Signature *signature)
	If the signature is a type that has a KeyLocator, then return it. More...

Member Function Documentation

bool ndn::KeyLocator::canGetFromSignature ( const Signature * signature )

static

If the signature is a type that has a KeyLocator (so that getFromSignature will succeed), return true.

Note: This is a static method of KeyLocator instead of a method of Signature so that the Signature base class does not need to be overloaded with all the different kinds of information that various signature algorithms may use.

Parameters

signature An object of a subclass of Signature.

Returns: True if the signature is a type that has a KeyLocator, otherwise false.

void ndn::KeyLocator::get ( struct ndn_KeyLocator & keyLocatorStruct ) const

Set the keyLocatorStruct to point to the values in this key locator, without copying any memory.

WARNING: The resulting pointers in keyLocatorStruct are invalid after a further use of this object which could reallocate memory.

Parameters

keyLocatorStruct a C ndn_KeyLocator struct where the name components array is already allocated.

uint64_t ndn::KeyLocator::getChangeCount ( ) const

inline

Get the change count, which is incremented each time this object (or a child object) is changed.

Returns: The change count.

const KeyLocator & ndn::KeyLocator::getFromSignature ( const Signature * signature )

static

If the signature is a type that has a KeyLocator, then return it.

Otherwise throw an error.

Parameters

signature An object of a subclass of Signature.

Returns: The signature's KeyLocator. It is an error if signature doesn't have a KeyLocator.

ndn_KeyNameType DEPRECATED_IN_NDN_CPP ndn::KeyLocator::getKeyNameType ( ) const

inline

Deprecated:: The use of a digest attached to the KeyName is deprecated. KEY_LOCATOR_DIGEST is supported as a keyLocatorType.

void ndn::KeyLocator::set ( const struct ndn_KeyLocator & keyLocatorStruct )

Clear this key locator, and set the values by copying from the ndn_KeyLocator struct.

Parameters

keyLocatorStruct a C ndn_KeyLocator struct

void DEPRECATED_IN_NDN_CPP ndn::KeyLocator::setKeyNameType ( ndn_KeyNameType keyNameType )

inline

Deprecated:: The use of a digest attached to the KeyName is deprecated. If you need a publisher public key digest, set the keyLocatorType to KEY_LOCATOR_DIGEST and set the key data to the digest.

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

include/ndn-cpp/key-locator.hpp
src/key-locator.cpp

Public Member Functions

Static Public Member Functions

Member Function Documentation