Heph::TimeoutException Class Reference

raised when an operation takes too long to complete and reaches timeout. More...

#include <TimeoutException.h>

Inheritance diagram for Heph::TimeoutException:

Public Member Functions
	TimeoutException ()
	TimeoutException (const std::string &method, const std::string &message)
virtual std::string	GetName () const override
Public Member Functions inherited from Heph::Exception
	Exception ()
	Exception (const std::string &method, const std::string &message)
virtual	~Exception ()=default
virtual const char *	what () const noexcept override
virtual const std::string &	GetMethod () const
virtual const std::string &	GetMessage () const
virtual void	Raise (const void *pSender) const

Protected Member Functions
virtual void	AddToExceptions () const override

Additional Inherited Members
Static Public Member Functions inherited from Heph::Exception
static std::shared_ptr< Exception >	GetLastException () noexcept
static std::vector< std::shared_ptr< Exception > > &	GetExceptions () noexcept
static void	DefaultHandler (const EventParams &params)
Static Public Attributes inherited from Heph::Exception
static Event	OnException = Event()
Protected Attributes inherited from Heph::Exception
std::string	method
std::string	message

Detailed Description

raised when an operation takes too long to complete and reaches timeout.

Constructor & Destructor Documentation

TimeoutException() [1/2]

Heph::TimeoutException::TimeoutException

(

)

creates a new instance and initializes it with default values.

TimeoutException() [2/2]

Heph::TimeoutException::TimeoutException	(	const std::string &	method,
		const std::string &	message )

creates a new instance and initializes it with the provided values.

Parameters

method	name of the method where the exception occurred.
message	description of the exception.

Member Function Documentation

GetName()

virtual std::string Heph::TimeoutException::GetName ( ) const

overridevirtual

gets the human readable name of the exception.

Reimplemented from Heph::Exception.

AddToExceptions()

virtual void Heph::TimeoutException::AddToExceptions ( ) const

overrideprotectedvirtual

adds the exception to the thread local exceptions vector.

Reimplemented from Heph::Exception.