Botan::Pipe::Invalid_Message_Number Class Reference

#include <pipe.h>

Inheritance diagram for Botan::Pipe::Invalid_Message_Number:

Public Member Functions
virtual int	error_code () const noexcept
ErrorType	error_type () const noexcept override
	Invalid_Message_Number (std::string_view 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 40 of file pipe.h.

Constructor & Destructor Documentation

Invalid_Message_Number()

Botan::Pipe::Invalid_Message_Number::Invalid_Message_Number	(	std::string_view	where,
		message_id	msg )

Parameters

where	the error occurred
msg	the invalid message id that was used

Definition at line 32 of file pipe.cpp.

                                                                                       :
      Invalid_Argument(fmt("Pipe::{}: Invalid message number {}", where, msg)) {}

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.

Reimplemented in Botan::CommonCrypto_Error, Botan::Compression_Error, Botan::PKCS11::PKCS11_ReturnError, Botan::SQL_Database::SQL_DB_Error, Botan::System_Error, Botan::TLS::TLS_Exception, Botan::TPM2::Error, and Botan_FFI::FFI_Error.

Definition at line 107 of file exceptn.h.

{ 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::Invalid_IV_Length, and Botan::Invalid_Key_Length.

Definition at line 139 of file exceptn.h.

{ return ErrorType::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 93 of file exceptn.h.

{ return m_msg.c_str(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan_FFI::ffi_guard_thunk(), Botan::TLS::Callbacks::tls_ephemeral_key_agreement(), Botan::TLS::Callbacks::tls_kem_encapsulate(), and Botan::X509_Certificate::to_string().

---

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

• src/lib/filters/pipe.h
• src/lib/filters/pipe.cpp