Botan  2.11.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::System_Error Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::System_Error:
Botan::Exception

Public Member Functions

int error_code () const noexcept override
 
ErrorType error_type () const noexcept override
 
 System_Error (const std::string &msg)
 
 System_Error (const std::string &msg, int err_code)
 
const char * what () const noexcept override
 

Detailed Description

System_Error

This exception is thrown in the event of an error related to interacting with the operating system.

This exception type also (optionally) captures an integer error code eg POSIX errno or Windows GetLastError.

Definition at line 321 of file exceptn.h.

Constructor & Destructor Documentation

◆ System_Error() [1/2]

Botan::System_Error::System_Error ( const std::string &  msg)
inline

Definition at line 324 of file exceptn.h.

324 : Exception(msg), m_error_code(0) {}
Exception(const std::string &msg)
Definition: exceptn.cpp:71

◆ System_Error() [2/2]

Botan::System_Error::System_Error ( const std::string &  msg,
int  err_code 
)

Definition at line 168 of file exceptn.cpp.

168  :
169  Exception(msg + " error code " + std::to_string(err_code)),
170  m_error_code(err_code)
171  {}
Exception(const std::string &msg)
Definition: exceptn.cpp:71
std::string to_string(ErrorType type)
Convert an ErrorType to string.
Definition: exceptn.cpp:11

Member Function Documentation

◆ error_code()

int Botan::System_Error::error_code ( ) const
inlineoverridevirtualnoexcept

Return an error code associated with this exception, or otherwise 0.

The domain of this error varies depending on the source, for example on POSIX systems it might be errno, while on a Windows system it might be the result of GetLastError or WSAGetLastError. For error_type() is OpenSSLError, it will (if nonzero) be an OpenSSL error code from ERR_get_error.

Reimplemented from Botan::Exception.

Definition at line 330 of file exceptn.h.

330 { return m_error_code; }

◆ error_type()

ErrorType Botan::System_Error::error_type ( ) const
inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 328 of file exceptn.h.

References Botan::SystemError.

◆ what()

const char* Botan::Exception::what ( ) const
inlineoverridenoexceptinherited

Return a descriptive string which is hopefully comprehensible to a developer. It will likely not be useful for an end user.

The string has no particular format, and the content of exception messages may change from release to release. Thus the main use of this function is for logging or debugging.

Definition at line 94 of file exceptn.h.

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::RSA_PrivateKey::create_decryption_op(), Botan::RSA_PublicKey::create_encryption_op(), and Botan_FFI::ffi_guard_thunk().

94 { return m_msg.c_str(); }

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