Botan  2.9.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::Pipe::Invalid_Message_Number Class Referencefinal

#include <pipe.h>

Inheritance diagram for Botan::Pipe::Invalid_Message_Number:
Botan::Invalid_Argument Botan::Exception

Public Member Functions

virtual int error_code () const noexcept
 
ErrorType error_type () const noexcept override
 
 Invalid_Message_Number (const std::string &where, message_id msg)
 
const char * what () const noexcept override
 

Detailed Description

Exception if you use an invalid message as an argument to read, remaining, etc

Definition at line 41 of file pipe.h.

Constructor & Destructor Documentation

◆ Invalid_Message_Number()

Botan::Pipe::Invalid_Message_Number::Invalid_Message_Number ( const std::string &  where,
message_id  msg 
)
inline
Parameters
wherethe error occurred
msgthe invalid message id that was used

Definition at line 48 of file pipe.h.

48  :
49  Invalid_Argument("Pipe::" + where + ": Invalid message number " +
50  std::to_string(msg))
51  {}
Invalid_Argument(const std::string &msg)
Definition: exceptn.cpp:22
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:210

Member Function Documentation

◆ error_code()

virtual int Botan::Exception::error_code ( ) const
inlinevirtualnoexceptinherited

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 in Botan::System_Error, Botan::Compression_Error, Botan::OpenSSL_Error, Botan::CommonCrypto_Error, Botan::TLS::TLS_Exception, and Botan_FFI::FFI_Error.

Definition at line 103 of file exceptn.h.

103 { return 0; }

◆ error_type()

ErrorType Botan::Invalid_Argument::error_type ( ) const
inlineoverridevirtualnoexceptinherited

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Reimplemented in Botan::Decoding_Error, Botan::Encoding_Error, Botan::Invalid_IV_Length, and Botan::Invalid_Key_Length.

Definition at line 126 of file exceptn.h.

References Botan::InvalidArgument.

◆ 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 87 of file exceptn.h.

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

87 { return m_msg.c_str(); }

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