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

Container of identities of a Pib. More...

#include <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
const_iterator	begin () const
const_iterator	end () const
const_iterator	find (const Name &keyId) const
size_t	size () const
Identity	add (const Name &identityName)
	Add identity into the container. More...
void	remove (const Name &identity)
	Remove identity from the container. More...
Identity	get (const Name &identity) const
	Get identity from the container. More...
void	reset ()
	Reset state of the container. More...
bool	isConsistent () const
	Check if the container is consistent with the backend storage. More...
const std::set< Name > &	getIdentityNames () const
const std::unordered_map< Name, shared_ptr< detail::IdentityImpl > > &	getLoadedIdentities () const

Public Attributes
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: explicit IdentityContainer(shared_ptr<PibImpl> pibImpl)

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 46 of file identity-container.hpp.

Member Typedef Documentation

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

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

Member Function Documentation

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

(

)

const

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

References ndn::security::pib::IdentityContainer::const_iterator::const_iterator().

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

(

)

const

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

References ndn::security::pib::IdentityContainer::const_iterator::const_iterator().

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

(

const Name &

keyId

)

const

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

References ndn::security::pib::IdentityContainer::const_iterator::const_iterator().

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

(

)

const

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

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

(

const Name &

identityName

)

Add identity into the container.

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

Referenced by ndn::security::pib::Pib::addIdentity(), and ndn::security::pib::Pib::setDefaultIdentity().

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

(

const Name &

identity

)

Remove identity from the container.

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

Referenced by ndn::security::pib::Pib::removeIdentity().

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 134 of file identity-container.cpp.

Referenced by ndn::security::pib::Pib::getDefaultIdentity(), ndn::security::pib::Pib::getIdentity(), and ndn::security::pib::IdentityContainer::const_iterator::operator*().

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 150 of file identity-container.cpp.

Referenced by ndn::security::pib::Pib::reset().

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 157 of file identity-container.cpp.

Referenced by ndn::security::pib::Pib::addIdentity(), ndn::security::pib::Pib::getDefaultIdentity(), ndn::security::pib::Pib::getIdentities(), ndn::security::pib::Pib::getIdentity(), ndn::security::pib::Pib::removeIdentity(), and ndn::security::pib::Pib::setDefaultIdentity().

const std::set<Name>& ndn::security::pib::IdentityContainer::getIdentityNames ( ) const

inline

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

const std::unordered_map<Name, shared_ptr<detail::IdentityImpl> >& ndn::security::pib::IdentityContainer::getLoadedIdentities ( ) const

inline

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

Friends And Related Function Documentation

friend class Pib

friend

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

Member Data Documentation

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE ndn::security::pib::IdentityContainer::__pad0__

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

---

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

• ndnSIM/ndn-cxx/src/security/pib/identity-container.hpp
• ndnSIM/ndn-cxx/src/security/pib/identity-container.cpp