Exception Class Reference

Base class for all exceptions thrown by the library. More...

#include <cryptlib.h>

Inheritance diagram for Exception:

Collaboration diagram for Exception:

Public Types
enum	ErrorType {   NOT_IMPLEMENTED, INVALID_ARGUMENT, CANNOT_FLUSH, DATA_INTEGRITY_CHECK_FAILED,   INVALID_DATA_FORMAT, IO_ERROR, OTHER_ERROR }
	Error types or categories. More...

Public Member Functions
virtual	~Exception () throw ()
	Exception (ErrorType errorType, const std::string &s)
	Construct a new Exception. More...
const char *	what () const throw ()
	Retrieves a C-string describing the exception. More...
const std::string &	GetWhat () const
	Retrieves a string describing the exception. More...
void	SetWhat (const std::string &s)
	Sets the error string for the exception. More...
ErrorType	GetErrorType () const
	Retrieves the error type for the exception. More...
void	SetErrorType (ErrorType errorType)
	Sets the error type for the exceptions. More...

Private Attributes
ErrorType	m_errorType
std::string	m_what

Detailed Description

Base class for all exceptions thrown by the library.

All library exceptions directly or indirectly inherit from the Exception class. The Exception class itself inherits from std::exception. The library does not use std::runtime_error derived classes.

Definition at line 140 of file cryptlib.h.

Member Enumeration Documentation

enum Exception::ErrorType

Error types or categories.

Enumerator
NOT_IMPLEMENTED	A method was called which was not implemented.
INVALID_ARGUMENT	An invalid argument was detected.
CANNOT_FLUSH	BufferedTransformation received a Flush(true) signal but can't flush buffers.
DATA_INTEGRITY_CHECK_FAILED	Data integerity check, such as CRC or MAC, failed.
INVALID_DATA_FORMAT	Input data was received that did not conform to expected format.
IO_ERROR	Error reading from input device or writing to output device.
OTHER_ERROR	Some other error occurred not belonging to other categories.

Definition at line 145 of file cryptlib.h.

Constructor & Destructor Documentation

virtual Exception::~Exception ( ) throw ( )

inlinevirtual

Definition at line 162 of file cryptlib.h.

Exception::Exception ( ErrorType  errorType, const std::string &  s  )

inlineexplicit

Construct a new Exception.

Definition at line 165 of file cryptlib.h.

Here is the caller graph for this function:

Member Function Documentation

ErrorType Exception::GetErrorType ( ) const

inline

Retrieves the error type for the exception.

Definition at line 174 of file cryptlib.h.

const std::string& Exception::GetWhat ( ) const

inline

Retrieves a string describing the exception.

Definition at line 170 of file cryptlib.h.

void Exception::SetErrorType ( ErrorType  errorType )

inline

Sets the error type for the exceptions.

Definition at line 176 of file cryptlib.h.

void Exception::SetWhat ( const std::string &  s )

inline

Sets the error string for the exception.

Definition at line 172 of file cryptlib.h.

const char* Exception::what ( ) const throw ( )

inline

Retrieves a C-string describing the exception.

Definition at line 168 of file cryptlib.h.

Here is the caller graph for this function:

Member Data Documentation

ErrorType Exception::m_errorType

private

Definition at line 179 of file cryptlib.h.

std::string Exception::m_what

private

Definition at line 180 of file cryptlib.h.

---

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

• src/cryptopp/cryptlib.h