All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Member Functions | List of all members
ndn::KeyParams Class Reference

KeyParams is a base class for key parameters. More...

#include <key-params.hpp>

Inheritance diagram for ndn::KeyParams:
ndn::AesKeyParams ndn::EcKeyParams ndn::RsaKeyParams ndn::EcdsaKeyParams

Public Member Functions

KeyType getKeyType () const
 
KeyIdType getKeyIdType () const
 
void setKeyId (const Name::Component &keyId)
 
const Name::ComponentgetKeyId () const
 

Protected Member Functions

 KeyParams (KeyType keyType, KeyIdType keyIdType)
 Create a key generation parameter. More...
 
 KeyParams (KeyType keyType, const Name::Component &keyId)
 Create a key generation parameter. More...
 

Detailed Description

KeyParams is a base class for key parameters.

Its subclasses are used to store parameters for key generation.

Constructor & Destructor Documentation

ndn::KeyParams::KeyParams ( KeyType  keyType,
KeyIdType  keyIdType 
)
protected

Create a key generation parameter.

Parameters
keyTypeThe type for the created key.
keyIdTypeThe method for how the key id should be generated, which must not be KEY_ID_TYPE_USER_SPECIFIED.
Exceptions
std::runtime_errorif keyIdType is KEY_ID_TYPE_USER_SPECIFIED.
ndn::KeyParams::KeyParams ( KeyType  keyType,
const Name::Component keyId 
)
protected

Create a key generation parameter.

Parameters
keyTypeThe type for the created key.
keyIdThe user-specified key ID. This sets the keyIdType to KEY_ID_TYPE_USER_SPECIFIED. keyId must not be empty.
Exceptions
std::runtime_errorif keyId is empty.

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