IceBox::FailureException Class Reference

This exception is a general failure notification. More...

#include <IceBox/IceBox.h>

Inheritance diagram for IceBox::FailureException:

Collaboration diagram for IceBox::FailureException:

Public Member Functions
	FailureException (const char *file, int line)
	The file and line number are required for all local exceptions.
	FailureException (const char *file, int line, const ::std::string &reason)
	One-shot constructor to initialize all data members.
	FailureException (const FailureException &)=default
virtual void	ice_print (::std::ostream &stream) const override
	Prints this exception to the given stream.
std::tuple< const ::std::string & >	ice_tuple () const
	Obtains a tuple containing all of the exception's data members.
virtual	~FailureException ()
Public Member Functions inherited from Ice::LocalExceptionHelper< FailureException, ::Ice::LocalException >
virtual std::string	ice_id () const override
Public Member Functions inherited from IceUtil::ExceptionHelper< FailureException, ::Ice::LocalException >
std::unique_ptr< FailureException >	ice_clone () const
virtual void	ice_throw () const override
	Throws this exception.
Public Member Functions inherited from Ice::LocalException
std::unique_ptr< LocalException >	ice_clone () const
	Polymorphically clones this exception.
	LocalException (const char *file, int line)
	The file and line number are required for all local exceptions.
virtual	~LocalException () throw ()
Public Member Functions inherited from IceUtil::Exception
	Exception ()
	Constructs the exception.
	Exception (const char *file, int line)
	Constructs the exception.
std::unique_ptr< Exception >	ice_clone () const
	Returns a shallow polymorphic copy of this exception.
const char *	ice_file () const
	Returns the name of the file where this exception was constructed.
int	ice_line () const
	Returns the line number where this exception was constructed.
virtual void	ice_print (std::ostream &os) const
	Outputs a description of this exception to a stream.
std::string	ice_stackTrace () const
	Returns the stack trace at the point this exception was constructed.
virtual const char *	what () const throw ()
	Returns a description of this exception.
virtual	~Exception () throw () =0

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this exception.
Static Public Member Functions inherited from Ice::LocalException
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this exception.

Public Attributes
::std::string	reason
	The reason for the failure.

Detailed Description

This exception is a general failure notification.

It is thrown for errors such as a service encountering an error during initialization, or the service manager being unable to load a service executable.

Constructor & Destructor Documentation

~FailureException()

virtual IceBox::FailureException::~FailureException ( )

virtual

FailureException() [1/3]

IceBox::FailureException::FailureException ( const FailureException & )

default

FailureException() [2/3]

IceBox::FailureException::FailureException ( const char * file, int line )

inline

The file and line number are required for all local exceptions.

Parameters

file	The file name in which the exception was raised, typically __FILE__.
line	The line number at which the exception was raised, typically __LINE__.

FailureException() [3/3]

IceBox::FailureException::FailureException ( const char * file, int line, const ::std::string & reason )

inline

One-shot constructor to initialize all data members.

The file and line number are required for all local exceptions.

Parameters

file	The file name in which the exception was raised, typically __FILE__.
line	The line number at which the exception was raised, typically __LINE__.
reason	The reason for the failure.

Member Function Documentation

ice_print()

virtual void IceBox::FailureException::ice_print ( ::std::ostream & stream ) const

overridevirtual

Prints this exception to the given stream.

Parameters

stream

The target stream.

ice_staticId()

const ::std::string & IceBox::FailureException::ice_staticId ( )

static

Obtains the Slice type ID of this exception.

Returns

The fully-scoped type ID.

ice_tuple()

std::tuple< const ::std::string & > IceBox::FailureException::ice_tuple ( ) const

inline

Obtains a tuple containing all of the exception's data members.

Returns

The data members in a tuple.

Member Data Documentation

reason

::std::string IceBox::FailureException::reason

The reason for the failure.

---

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

• generated/cpp11/x64/Release/IceBox/IceBox.h