Ice::ProtocolException Class Reference

A generic exception base for all kinds of protocol error conditions. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::ProtocolException:

Collaboration diagram for Ice::ProtocolException:

Public Member Functions
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.
	ProtocolException (const char *file, int line)
	The file and line number are required for all local exceptions.
	ProtocolException (const char *file, int line, const ::std::string &reason)
	One-shot constructor to initialize all data members.
	ProtocolException (const ProtocolException &)=default
virtual	~ProtocolException ()
Public Member Functions inherited from Ice::LocalExceptionHelper< ProtocolException, LocalException >
virtual std::string	ice_id () const override
Public Member Functions inherited from IceUtil::ExceptionHelper< ProtocolException, LocalException >
std::unique_ptr< ProtocolException >	ice_clone () const
virtual void	ice_throw () const override
	Throws this exception.

Static Public Member Functions
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

A generic exception base for all kinds of protocol error conditions.

Constructor & Destructor Documentation

~ProtocolException()

virtual Ice::ProtocolException::~ProtocolException ( )

virtual

ProtocolException() [1/3]

Ice::ProtocolException::ProtocolException ( const ProtocolException & )

default

ProtocolException() [2/3]

Ice::ProtocolException::ProtocolException ( 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__.

ProtocolException() [3/3]

Ice::ProtocolException::ProtocolException ( 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 Ice::ProtocolException::ice_print ( ::std::ostream & stream ) const

overridevirtual

Prints this exception to the given stream.

Parameters

stream

The target stream.

ice_staticId()

const ::std::string & Ice::ProtocolException::ice_staticId ( )

static

Obtains the Slice type ID of this exception.

Returns

The fully-scoped type ID.

ice_tuple()

std::tuple< const ::std::string & > Ice::ProtocolException::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 Ice::ProtocolException::reason

The reason for the failure.

---

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

• generated/cpp11/x64/Release/Ice/LocalException.h