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

typedef const_iterator iterator
 

Public Member Functions

Key add (const uint8_t *key, size_t keyLen, const Name &keyName)
 Add key of keyLen bytes with 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
 

Friends

class detail::IdentityImpl
 

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

Member Function Documentation

Key ndn::security::pib::KeyContainer::add ( const uint8_t *  key,
size_t  keyLen,
const Name keyName 
)

Add key of keyLen bytes with keyName into the container.

Exceptions
std::invalid_argumentkeyName does not match the identity

If a key with the same name already exists, overwrite the key.

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

KeyContainer::const_iterator ndn::security::pib::KeyContainer::begin ( ) const

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

KeyContainer::const_iterator ndn::security::pib::KeyContainer::end ( ) const

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

KeyContainer::const_iterator ndn::security::pib::KeyContainer::find ( const Name keyName) const

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

Key ndn::security::pib::KeyContainer::get ( const Name keyName) const

Get a key with keyName from the container.

Exceptions
std::invalid_argumentkeyName does not match the identity
Pib::Errorthe key does not exist

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

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 165 of file key-container.cpp.

void ndn::security::pib::KeyContainer::remove ( const Name keyName)

Remove a key with keyName from the container.

Exceptions
std::invalid_argumentkeyName does not match the identity

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

size_t ndn::security::pib::KeyContainer::size ( ) const

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

Friends And Related Function Documentation

friend class detail::IdentityImpl
friend

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