A PibIdentityContainer is used to search/enumerate the identities in a PIB. More...

Public Member Functions
size_t	size () const
	Get the number of identities in the container. More...

ptr_lib::shared_ptr< PibIdentity >	add (const Name &identityName)
	Add an identity with name identityName into the container. More...

void	remove (const Name &identityName)
	Remove the identity with name identityName from the container, and its related keys and certificates. More...

ptr_lib::shared_ptr< PibIdentity >	get (const Name &identityName)
	Get the identity with name identityName from the container. More...

void	reset ()
	Reset the state of the container. More...

bool	isConsistent () const
	Check if the container is consistent with the backend storage. More...

Detailed Description

A PibIdentityContainer is used to search/enumerate the identities in a PIB.

(A PibIdentityContainer object can only be created by the Pib class.)

Member Function Documentation

ptr_lib::shared_ptr< PibIdentity > ndn::PibIdentityContainer::add ( const Name & identityName )

Add an identity with name identityName into the container.

Create the identity if it does not exist.

Parameters

identityName The name of the identity, which is copied.

ptr_lib::shared_ptr< PibIdentity > ndn::PibIdentityContainer::get ( const Name & identityName )

Get the identity with name identityName from the container.

Parameters

identityName The name of the identity.

Exceptions

Pib::Error if the identity does not exist.

bool ndn::PibIdentityContainer::isConsistent ( ) const

Check if the container is consistent with the backend storage.

Note: This method is heavy-weight and should be used in a debugging mode only.

void ndn::PibIdentityContainer::remove ( const Name & identityName )

Remove the identity with name identityName from the container, and its related keys and certificates.

If the default identity is being removed, no default identity will be selected. If the identity does not exist, do nothing.

Parameters

identityName The name of the identity.

void ndn::PibIdentityContainer::reset ( )

Reset the state of the container.

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

size_t ndn::PibIdentityContainer::size ( ) const

inline

Get the number of identities in the container.

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