ndn::KeyParams Class Reference

Base class for key parameters. More...

#include <ndn-cxx/security/key-params.hpp>

+ Inheritance diagram for ndn::KeyParams:

Classes

class  Error
 

Public Member Functions

virtual ~KeyParams ()
 
const name::ComponentgetKeyId () const
 
KeyIdType getKeyIdType () const
 
KeyType getKeyType () const
 
void setKeyId (const name::Component &keyId)
 

Protected Member Functions

 KeyParams (KeyType keyType, KeyIdType keyIdType)
 Constructor. More...
 
 KeyParams (KeyType keyType, const name::Component &keyId)
 Constructor. More...
 

Detailed Description

Base class for key parameters.

Its subclasses are used to store parameters for key generation.

Definition at line 35 of file key-params.hpp.

Constructor & Destructor Documentation

◆ ~KeyParams()

ndn::KeyParams::~KeyParams ( )
virtualdefault

◆ KeyParams() [1/2]

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

Constructor.

Parameters
keyTypeType of the created key
keyIdTypeThe method how the key id should be generated; must not be KeyIdType::USER_SPECIFIED

Definition at line 26 of file key-params.cpp.

◆ KeyParams() [2/2]

ndn::KeyParams::KeyParams ( KeyType  keyType,
const name::Component keyId 
)
protected

Constructor.

Parameters
keyTypeType of the created key
keyIdThe user-specified key id. The keyIdType will be set to KeyIdType::USER_SPECIFIED. keyId MUST NOT be the empty component.
Postcondition
getKeyIdType() == KeyIdType::USER_SPECIFIED

Definition at line 33 of file key-params.cpp.

Member Function Documentation

◆ getKeyId()

const name::Component& ndn::KeyParams::getKeyId ( ) const
inline

Definition at line 60 of file key-params.hpp.

◆ getKeyIdType()

KeyIdType ndn::KeyParams::getKeyIdType ( ) const
inline

Definition at line 54 of file key-params.hpp.

◆ getKeyType()

KeyType ndn::KeyParams::getKeyType ( ) const
inline

Definition at line 48 of file key-params.hpp.

◆ setKeyId()

void ndn::KeyParams::setKeyId ( const name::Component keyId)
inline

Definition at line 66 of file key-params.hpp.