IceUtil::Exception Class Reference

Abstract base class for all Ice exceptions. More...

#include <Ice/Ice.h>

Inheritance diagram for IceUtil::Exception:

Collaboration diagram for IceUtil::Exception:

Public Member Functions
	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.
virtual std::string	ice_id () const =0
	Returns the type ID of this exception.
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 void	ice_throw () const =0
	Throws this exception.
virtual const char *	what () const throw ()
	Returns a description of this exception.
virtual	~Exception () throw () =0

Detailed Description

Abstract base class for all Ice exceptions.

Use the Ice::Exception alias instead of IceUtil::Exception.

Constructor & Destructor Documentation

Exception() [1/2]

IceUtil::Exception::Exception

(

)

Constructs the exception.

Equivalent to Exception(nullptr, 0).

Exception() [2/2]

IceUtil::Exception::Exception	(	const char *	file,
		int	line )

Constructs the exception.

Parameters

file	The file where this exception is constructed.
line	The line where this exception is constructed.

~Exception()

virtual IceUtil::Exception::~Exception ( ) throw (  )

pure virtual

Member Function Documentation

ice_clone()

std::unique_ptr< Exception > IceUtil::Exception::ice_clone

(

)

const

Returns a shallow polymorphic copy of this exception.

Returns

A unique_ptr to the new shallow copy.

ice_file()

const char * IceUtil::Exception::ice_file

(

)

const

Returns the name of the file where this exception was constructed.

Returns

The file name.

ice_id()

virtual std::string IceUtil::Exception::ice_id ( ) const

pure virtual

Returns the type ID of this exception.

This corresponds to the Slice type ID for Slice-defined exceptions, and to a similar fully scoped name for other exceptions. For example "::IceUtil::SyscallException".

Returns

The type ID of this exception

Implemented in Glacier2::RestartSessionException, Ice::IconvInitializationException, Ice::LocalExceptionHelper< FailureException, ::Ice::LocalException >, Ice::LocalExceptionHelper< FileException, SyscallException >, Ice::LocalExceptionHelper< SocketException, SyscallException >, Ice::UserExceptionHelper< AccessDeniedException, ::Ice::UserException >, Ice::UserExceptionHelper< AdapterNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< AllocationException, ::Ice::UserException >, Ice::UserExceptionHelper< AlreadyStartedException, ::Ice::UserException >, Ice::UserExceptionHelper< AlreadyStoppedException, ::Ice::UserException >, Ice::UserExceptionHelper< AlreadySubscribed, ::Ice::UserException >, Ice::UserExceptionHelper< ApplicationNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< BadQoS, ::Ice::UserException >, Ice::UserExceptionHelper< BadSignalException, ::Ice::UserException >, Ice::UserExceptionHelper< CannotCreateSessionException, ::Ice::UserException >, Ice::UserExceptionHelper< DeploymentException, ::Ice::UserException >, Ice::UserExceptionHelper< FileNotAvailableException, ::Ice::UserException >, Ice::UserExceptionHelper< InvalidSubscriber, ::Ice::UserException >, Ice::UserExceptionHelper< LinkExists, ::Ice::UserException >, Ice::UserExceptionHelper< NodeNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< NodeUnreachableException, ::Ice::UserException >, Ice::UserExceptionHelper< NoSuchLink, ::Ice::UserException >, Ice::UserExceptionHelper< NoSuchServiceException, ::Ice::UserException >, Ice::UserExceptionHelper< NoSuchTopic, ::Ice::UserException >, Ice::UserExceptionHelper< ObjectExistsException, ::Ice::UserException >, Ice::UserExceptionHelper< ObjectNotRegisteredException, ::Ice::UserException >, Ice::UserExceptionHelper< ObserverAlreadyRegisteredException, ::Ice::UserException >, Ice::UserExceptionHelper< ParseException, ::Ice::UserException >, Ice::UserExceptionHelper< PatchException, ::Ice::UserException >, Ice::UserExceptionHelper< PermissionDeniedException, ::Ice::UserException >, Ice::UserExceptionHelper< RegistryNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< RegistryUnreachableException, ::Ice::UserException >, Ice::UserExceptionHelper< ServerNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< ServerStartException, ::Ice::UserException >, Ice::UserExceptionHelper< ServerStopException, ::Ice::UserException >, Ice::UserExceptionHelper< ServerUnreachableException, ::Ice::UserException >, Ice::UserExceptionHelper< SessionNotExistException, ::Ice::UserException >, Ice::UserExceptionHelper< TopicExists, ::Ice::UserException >, Ice::UserExceptionHelper< UnknownMetricsView, ::Ice::UserException >, Ice::UserExceptionHelper< UserAccountNotFoundException, ::Ice::UserException >, IceSSL::CertificateEncodingException, IceSSL::CertificateReadException, IceSSL::ParseException, IceUtil::BadThreadControlException, IceUtil::CtrlCHandlerException, IceUtil::FileLockException, IceUtil::IllegalArgumentException, IceUtil::IllegalConversionException, IceUtil::InvalidTimeoutException, IceUtil::NullHandleException, IceUtil::OptionalNotSetException, IceUtil::SyscallException, IceUtil::ThreadLockedException, IceUtil::ThreadNotStartedException, IceUtil::ThreadStartedException, and IceUtil::ThreadSyscallException.

ice_line()

int IceUtil::Exception::ice_line

(

)

const

Returns the line number where this exception was constructed.

Returns

The line number.

ice_print()

virtual void IceUtil::Exception::ice_print ( std::ostream & os ) const

virtual

Outputs a description of this exception to a stream.

Parameters

os	The output stream.

Reimplemented in Ice::IconvInitializationException, IceUtil::FileLockException, IceUtil::IllegalArgumentException, IceUtil::IllegalConversionException, IceUtil::InvalidTimeoutException, and IceUtil::SyscallException.

ice_stackTrace()

std::string IceUtil::Exception::ice_stackTrace

(

)

const

Returns the stack trace at the point this exception was constructed.

Returns

The stack trace as a string.

ice_throw()

virtual void IceUtil::Exception::ice_throw ( ) const

pure virtual

Throws this exception.

Implemented in IceUtil::ExceptionHelper< E, B >, IceUtil::ExceptionHelper< AccessDeniedException, ::Ice::UserException >, IceUtil::ExceptionHelper< AdapterNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< AllocationException, ::Ice::UserException >, IceUtil::ExceptionHelper< AlreadyStartedException, ::Ice::UserException >, IceUtil::ExceptionHelper< AlreadyStoppedException, ::Ice::UserException >, IceUtil::ExceptionHelper< AlreadySubscribed, ::Ice::UserException >, IceUtil::ExceptionHelper< APIException >, IceUtil::ExceptionHelper< ApplicationNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< BadOptException >, IceUtil::ExceptionHelper< BadQoS, ::Ice::UserException >, IceUtil::ExceptionHelper< BadSignalException, ::Ice::UserException >, IceUtil::ExceptionHelper< BadThreadControlException >, IceUtil::ExceptionHelper< CannotCreateSessionException, ::Ice::UserException >, IceUtil::ExceptionHelper< CertificateEncodingException >, IceUtil::ExceptionHelper< CertificateReadException >, IceUtil::ExceptionHelper< CtrlCHandlerException >, IceUtil::ExceptionHelper< DeploymentException, ::Ice::UserException >, IceUtil::ExceptionHelper< E, SyscallException >, IceUtil::ExceptionHelper< FailureException, ::Ice::LocalException >, IceUtil::ExceptionHelper< FileException, SyscallException >, IceUtil::ExceptionHelper< FileLockException >, IceUtil::ExceptionHelper< FileNotAvailableException, ::Ice::UserException >, IceUtil::ExceptionHelper< IconvInitializationException >, IceUtil::ExceptionHelper< IllegalArgumentException >, IceUtil::ExceptionHelper< IllegalConversionException >, IceUtil::ExceptionHelper< InvalidSubscriber, ::Ice::UserException >, IceUtil::ExceptionHelper< InvalidTimeoutException >, IceUtil::ExceptionHelper< LinkExists, ::Ice::UserException >, IceUtil::ExceptionHelper< NodeNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< NodeUnreachableException, ::Ice::UserException >, IceUtil::ExceptionHelper< NoSuchLink, ::Ice::UserException >, IceUtil::ExceptionHelper< NoSuchServiceException, ::Ice::UserException >, IceUtil::ExceptionHelper< NoSuchTopic, ::Ice::UserException >, IceUtil::ExceptionHelper< NullHandleException >, IceUtil::ExceptionHelper< ObjectExistsException, ::Ice::UserException >, IceUtil::ExceptionHelper< ObjectNotRegisteredException, ::Ice::UserException >, IceUtil::ExceptionHelper< ObserverAlreadyRegisteredException, ::Ice::UserException >, IceUtil::ExceptionHelper< OptionalNotSetException >, IceUtil::ExceptionHelper< ParseException >, IceUtil::ExceptionHelper< ParseException, ::Ice::UserException >, IceUtil::ExceptionHelper< PatchException, ::Ice::UserException >, IceUtil::ExceptionHelper< PermissionDeniedException, ::Ice::UserException >, IceUtil::ExceptionHelper< RegistryNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< RegistryUnreachableException, ::Ice::UserException >, IceUtil::ExceptionHelper< RestartSessionException >, IceUtil::ExceptionHelper< ServerNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< ServerStartException, ::Ice::UserException >, IceUtil::ExceptionHelper< ServerStopException, ::Ice::UserException >, IceUtil::ExceptionHelper< ServerUnreachableException, ::Ice::UserException >, IceUtil::ExceptionHelper< SessionNotExistException, ::Ice::UserException >, IceUtil::ExceptionHelper< SocketException, SyscallException >, IceUtil::ExceptionHelper< SyscallException >, IceUtil::ExceptionHelper< ThreadLockedException >, IceUtil::ExceptionHelper< ThreadNotStartedException >, IceUtil::ExceptionHelper< ThreadStartedException >, IceUtil::ExceptionHelper< TopicExists, ::Ice::UserException >, IceUtil::ExceptionHelper< UnknownMetricsView, ::Ice::UserException >, and IceUtil::ExceptionHelper< UserAccountNotFoundException, ::Ice::UserException >.

what()

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

virtual

Returns a description of this exception.

Returns

The description.

---

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

• IceUtil/Exception.h