Keypop Calypso Crypto Symmetric C++ API - 0.1.1
Component of the Keypop C++ API
keypop::calypso::crypto::symmetric::SymmetricCryptoException Class Referencefinal

Indicates that an error occurred when processing a command. More...

#include <keypop/calypso/crypto/symmetric/SymmetricCryptoException.hpp>

Inheritance diagram for keypop::calypso::crypto::symmetric::SymmetricCryptoException:
Collaboration diagram for keypop::calypso::crypto::symmetric::SymmetricCryptoException:

Public Member Functions

 SymmetricCryptoException (const std::string &message)
 
 SymmetricCryptoException (const std::string &message, const std::exception &cause)
 Encapsulates a lower level exception. More...
 
const char * what () const noexcept override
 Returns the detail message, so that what() reports it instead of the default "Unknown exception" of std::exception. More...
 
const std::string & getCause () const noexcept
 Returns the message of the underlying cause, empty if none. More...
 

Detailed Description

Indicates that an error occurred when processing a command.

Since
0.1.0

Definition at line 27 of file SymmetricCryptoException.hpp.

Constructor & Destructor Documentation

◆ SymmetricCryptoException() [1/2]

keypop::calypso::crypto::symmetric::SymmetricCryptoException::SymmetricCryptoException ( const std::string &  message)
inlineexplicit
Parameters
messageThe message to identify the exception context.
Since
0.1.0

Definition at line 33 of file SymmetricCryptoException.hpp.

◆ SymmetricCryptoException() [2/2]

keypop::calypso::crypto::symmetric::SymmetricCryptoException::SymmetricCryptoException ( const std::string &  message,
const std::exception &  cause 
)
inline

Encapsulates a lower level exception.

Parameters
messageMessage to identify the exception context.
causeThe cause.
Since
0.1.0

Definition at line 45 of file SymmetricCryptoException.hpp.

Member Function Documentation

◆ getCause()

const std::string & keypop::calypso::crypto::symmetric::SymmetricCryptoException::getCause ( ) const
inlinenoexcept

Returns the message of the underlying cause, empty if none.

Definition at line 66 of file SymmetricCryptoException.hpp.

◆ what()

const char * keypop::calypso::crypto::symmetric::SymmetricCryptoException::what ( ) const
inlineoverridenoexcept

Returns the detail message, so that what() reports it instead of the default "Unknown exception" of std::exception.

Definition at line 57 of file SymmetricCryptoException.hpp.


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