ndn::security::pib::IdentityContainer Class Reference

Container of identities of a Pib. More...

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

Inheritance diagram for ndn::security::pib::IdentityContainer:

Collaboration diagram for ndn::security::pib::IdentityContainer:

Classes
class	const_iterator

Public Types
typedef const_iterator	iterator

Public Member Functions
Identity	add (const Name &identityName)
	Add identity into the container. More...
const_iterator	begin () const
const_iterator	end () const
const_iterator	find (const Name &keyId) const
Identity	get (const Name &identity) const
	Get identity from the container. More...
bool	isConsistent () const
	Check if the container is consistent with the backend storage. More...
void	remove (const Name &identity)
	Remove identity from the container. More...
void	reset ()
	Reset state of the container. More...
size_t	size () const

Friends
class	Pib

Detailed Description

Container of identities of a Pib.

The container is used to search/enumerate identities of a Pib. The container can be created only by Pib.

Definition at line 47 of file identity-container.hpp.

Member Typedef Documentation

iterator

typedef const_iterator ndn::security::pib::IdentityContainer::iterator

Definition at line 86 of file identity-container.hpp.

Member Function Documentation

add()

Identity ndn::security::pib::IdentityContainer::add

(

const Name &

identityName

)

Add identity into the container.

Definition at line 115 of file identity-container.cpp.

begin()

IdentityContainer::const_iterator ndn::security::pib::IdentityContainer::begin

(

)

const

Definition at line 91 of file identity-container.cpp.

end()

IdentityContainer::const_iterator ndn::security::pib::IdentityContainer::end

(

)

const

Definition at line 97 of file identity-container.cpp.

find()

IdentityContainer::const_iterator ndn::security::pib::IdentityContainer::find

(

const Name &

keyId

)

const

Definition at line 103 of file identity-container.cpp.

get()

Identity ndn::security::pib::IdentityContainer::get

(

const Name &

identity

)

const

Get identity from the container.

Exceptions

Pib::Error

identity does not exist

Definition at line 133 of file identity-container.cpp.

isConsistent()

bool ndn::security::pib::IdentityContainer::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 156 of file identity-container.cpp.

remove()

void ndn::security::pib::IdentityContainer::remove

(

const Name &

identity

)

Remove identity from the container.

Definition at line 125 of file identity-container.cpp.

reset()

void ndn::security::pib::IdentityContainer::reset

(

)

Reset state of the container.

This method removes all loaded identities and retrieves identity names from the PIB implementation.

Definition at line 149 of file identity-container.cpp.

size()

size_t ndn::security::pib::IdentityContainer::size

(

)

const

Definition at line 109 of file identity-container.cpp.

Friends And Related Function Documentation

Pib

friend class Pib

friend

Definition at line 164 of file identity-container.hpp.