ndn::security::pib::KeyContainer Class Reference

Container of keys of an identity. More...

#include <ndn-cxx/security/pib/key-container.hpp>

Inheritance diagram for ndn::security::pib::KeyContainer:

Collaboration diagram for ndn::security::pib::KeyContainer:

Classes
class	const_iterator

Public Types
using	iterator = const_iterator

Public Member Functions
Key	add (span< const uint8_t > key, const Name &keyName)
	Add key with name keyName into the container. More...
const_iterator	begin () const
const_iterator	end () const
const_iterator	find (const Name &keyName) const
Key	get (const Name &keyName) const
	Get a key with keyName from the container. More...
bool	isConsistent () const
	Check if the container is consistent with the backend storage. More...
void	remove (const Name &keyName)
	Remove a key with keyName from the container. More...
size_t	size () const

Detailed Description

Container of keys of an identity.

The container is used to search/enumerate keys of an identity. The container can be created only by detail::IdentityImpl.

Definition at line 48 of file key-container.hpp.

Member Typedef Documentation

iterator

using ndn::security::pib::KeyContainer::iterator = const_iterator

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

Member Function Documentation

add()

Key ndn::security::pib::KeyContainer::add	(	span< const uint8_t >	key,
		const Name &	keyName
	)

Add key with name keyName into the container.

If a key with the same name already exists, it will be overwritten.

Exceptions

std::invalid_argument

keyName does not match the identity

Definition at line 116 of file key-container.cpp.

begin()

KeyContainer::const_iterator ndn::security::pib::KeyContainer::begin

(

)

const

Definition at line 92 of file key-container.cpp.

end()

KeyContainer::const_iterator ndn::security::pib::KeyContainer::end

(

)

const

Definition at line 98 of file key-container.cpp.

find()

KeyContainer::const_iterator ndn::security::pib::KeyContainer::find

(

const Name &

keyName

)

const

Definition at line 104 of file key-container.cpp.

get()

Key ndn::security::pib::KeyContainer::get

(

const Name &

keyName

)

const

Get a key with keyName from the container.

Exceptions

std::invalid_argument	keyName does not match the identity
Pib::Error	the key does not exist

Definition at line 142 of file key-container.cpp.

isConsistent()

bool ndn::security::pib::KeyContainer::isConsistent

(

)

const

Check if the container is consistent with the backend storage.

Note

this method is heavyweight and should be used in debugging mode only.

Definition at line 164 of file key-container.cpp.

remove()

void ndn::security::pib::KeyContainer::remove

(

const Name &

keyName

)

Remove a key with keyName from the container.

Exceptions

std::invalid_argument

keyName does not match the identity

Definition at line 129 of file key-container.cpp.

size()

size_t ndn::security::pib::KeyContainer::size

(

)

const

Definition at line 110 of file key-container.cpp.