ndn::EncryptParamsLite Class Reference

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

#include <encrypt-params-lite.hpp>

Inheritance diagram for ndn::EncryptParamsLite:

Public Member Functions
	EncryptParamsLite ()
	Create an EncryptParamsLite with defaults for all the values.
ndn_EncryptAlgorithmType	getAlgorithmType () const
	Get the algorithm type. More...
const BlobLite &	getInitialVector () const
	Get the initial vector. More...
EncryptParamsLite &	setAlgorithmType (ndn_EncryptAlgorithmType algorithmType)
	Set the algorithm type. More...
EncryptParamsLite &	setInitialVector (const BlobLite &initialVector)
	Set the initial vector. More...

Static Public Member Functions
static EncryptParamsLite &	downCast (ndn_EncryptParams &encryptParams)
	Downcast the reference to the ndn_EncryptParams struct to an EncryptParamsLite. More...
static const EncryptParamsLite &	downCast (const ndn_EncryptParams &encryptParams)

Detailed Description

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

Note

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

Member Function Documentation

static EncryptParamsLite& ndn::EncryptParamsLite::downCast ( ndn_EncryptParams &  encryptParams )

inlinestatic

Downcast the reference to the ndn_EncryptParams struct to an EncryptParamsLite.

Parameters

keyLocator

A reference to the ndn_EncryptParams struct.

Returns

The same reference as EncryptParamsLite.

ndn_EncryptAlgorithmType ndn::EncryptParamsLite::getAlgorithmType ( ) const

inline

Get the algorithm type.

Returns

The algorithm type, or -1 if not specified.

const BlobLite& ndn::EncryptParamsLite::getInitialVector ( ) const

inline

Get the initial vector.

Returns

The initial vector. If not specified, isNull() is true.

EncryptParamsLite& ndn::EncryptParamsLite::setAlgorithmType ( ndn_EncryptAlgorithmType  algorithmType )

inline

Set the algorithm type.

Parameters

algorithmType

The algorithm type. If not specified, set to -1.

Returns

This EncryptParamsLite so that you can chain calls to update values.

EncryptParamsLite& ndn::EncryptParamsLite::setInitialVector ( const BlobLite &  initialVector )

inline

Set the initial vector.

Parameters

initialVector

The initial vector. If not specified, set to the default BlobLite() where isNull() is true.

Returns

This EncryptParamsLite so that you can chain calls to update values.

---

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

• include/ndn-cpp/lite/encrypt/algo/encrypt-params-lite.hpp
• src/lite/encrypt/algo/encrypt-params-lite.cpp