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

An EncryptParams holds an algorithm type and other parameters used to encrypt and decrypt. More...

#include <encrypt-params.hpp>

Public Member Functions

 EncryptParams (ndn_EncryptAlgorithmType algorithmType, size_t initialVectorLength)
 Create an EncryptParams with the given parameters. More...
 
 EncryptParams (ndn_EncryptAlgorithmType algorithmType)
 Create an EncryptParams with the given algorithmType and an unspecified initial vector. More...
 
ndn_EncryptAlgorithmType getAlgorithmType () const
 Get the algorithm type. More...
 
const BlobgetInitialVector () const
 Get the initial vector. More...
 
EncryptParamssetAlgorithmType (ndn_EncryptAlgorithmType algorithmType)
 Set the algorithm type. More...
 
EncryptParamssetInitialVector (const Blob &initialVector)
 Set the initial vector. More...
 

Detailed Description

An EncryptParams holds an algorithm type and other parameters used to encrypt and decrypt.

Note
This class is an experimental feature. The API may change.

Constructor & Destructor Documentation

ndn::EncryptParams::EncryptParams ( ndn_EncryptAlgorithmType  algorithmType,
size_t  initialVectorLength 
)

Create an EncryptParams with the given parameters.

Parameters
algorithmTypeThe algorithm type, or -1 if not specified.
initialVectorLengthThe initial vector length, or 0 if the initial vector is not specified.
ndn::EncryptParams::EncryptParams ( ndn_EncryptAlgorithmType  algorithmType)
inline

Create an EncryptParams with the given algorithmType and an unspecified initial vector.

Parameters
algorithmTypeThe algorithm type, or -1 if not specified.

Member Function Documentation

ndn_EncryptAlgorithmType ndn::EncryptParams::getAlgorithmType ( ) const
inline

Get the algorithm type.

Returns
The algorithm type, or -1 if not specified.
const Blob& ndn::EncryptParams::getInitialVector ( ) const
inline

Get the initial vector.

Returns
The initial vector. If not specified, isNull() is true.
EncryptParams& ndn::EncryptParams::setAlgorithmType ( ndn_EncryptAlgorithmType  algorithmType)
inline

Set the algorithm type.

Parameters
algorithmTypeThe algorithm type. If not specified, set to -1.
Returns
This EncryptParams so that you can chain calls to update values.
EncryptParams& ndn::EncryptParams::setInitialVector ( const Blob initialVector)
inline

Set the initial vector.

Parameters
initialVectorThe initial vector. If not specified, set to the default Blob() where isNull() is true.
Returns
This EncryptParams so that you can chain calls to update values.

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