Conscience Core
Public Member Functions | List of all members
jwt::helper::evp_pkey_handle Class Reference

Handle class for EVP_PKEY structures. More...

#include <jwt.h>

Public Member Functions

constexpr evp_pkey_handle () noexcept=default
 
constexpr evp_pkey_handle (EVP_PKEY *key) noexcept
 Construct a new handle. The handle takes ownership of the key. More...
 
 evp_pkey_handle (const evp_pkey_handle &other)
 
 evp_pkey_handle (evp_pkey_handle &&other) noexcept
 
evp_pkey_handleoperator= (const evp_pkey_handle &other)
 
evp_pkey_handleoperator= (evp_pkey_handle &&other) noexcept
 
evp_pkey_handleoperator= (EVP_PKEY *key)
 
 ~evp_pkey_handle () noexcept
 
EVP_PKEY * get () const noexcept
 
bool operator! () const noexcept
 
 operator bool () const noexcept
 

Detailed Description

Handle class for EVP_PKEY structures.

Starting from OpenSSL 1.1.0, EVP_PKEY has internal reference counting. This handle class allows jwt-cpp to leverage that and thus safe an allocation for the control block in std::shared_ptr. The handle uses shared_ptr as a fallback on older versions. The behaviour should be identical between both.

Constructor & Destructor Documentation

◆ evp_pkey_handle() [1/4]

constexpr jwt::helper::evp_pkey_handle::evp_pkey_handle ( )
constexprdefaultnoexcept

◆ evp_pkey_handle() [2/4]

constexpr jwt::helper::evp_pkey_handle::evp_pkey_handle ( EVP_PKEY *  key)
inlineexplicitconstexprnoexcept

Construct a new handle. The handle takes ownership of the key.

Parameters
keyThe key to store

◆ evp_pkey_handle() [3/4]

jwt::helper::evp_pkey_handle::evp_pkey_handle ( const evp_pkey_handle other)
inline

◆ evp_pkey_handle() [4/4]

jwt::helper::evp_pkey_handle::evp_pkey_handle ( evp_pkey_handle &&  other)
inlinenoexcept

◆ ~evp_pkey_handle()

jwt::helper::evp_pkey_handle::~evp_pkey_handle ( )
inlinenoexcept

Member Function Documentation

◆ get()

EVP_PKEY* jwt::helper::evp_pkey_handle::get ( ) const
inlinenoexcept

◆ operator bool()

jwt::helper::evp_pkey_handle::operator bool ( ) const
inlineexplicitnoexcept

◆ operator!()

bool jwt::helper::evp_pkey_handle::operator! ( ) const
inlinenoexcept

◆ operator=() [1/3]

evp_pkey_handle& jwt::helper::evp_pkey_handle::operator= ( const evp_pkey_handle other)
inline

◆ operator=() [2/3]

evp_pkey_handle& jwt::helper::evp_pkey_handle::operator= ( EVP_PKEY *  key)
inline

◆ operator=() [3/3]

evp_pkey_handle& jwt::helper::evp_pkey_handle::operator= ( evp_pkey_handle &&  other)
inlinenoexcept

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