Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
Ice::CloseConnectionException Class Reference

This exception indicates that the connection has been gracefully shut down by the server. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::CloseConnectionException:
Collaboration diagram for Ice::CloseConnectionException:

Public Member Functions

 CloseConnectionException (const char *file, int line)
 The file and line number are required for all local exceptions.
 CloseConnectionException (const char *file, int line, const ::std::string &reason)
 One-shot constructor to initialize all data members.
virtual CloseConnectionExceptionice_clone () const
 Polymorphically clones this exception.
virtual::std::string ice_id () const
 Obtains the Slice type ID of this exception.
virtual void ice_print (::std::ostream &stream) const
 Prints this exception to the given stream.
virtual void ice_throw () const
 Throws this exception.
virtual ~CloseConnectionException () throw ()
Public Member Functions inherited from Ice::ProtocolException
virtual::std::string ice_id () const
 Obtains the Slice type ID of this exception.
 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.
virtual ~ProtocolException () throw ()
Public Member Functions inherited from Ice::LocalException
 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.
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.
std::string ice_name () const
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

Additional Inherited Members

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

Detailed Description

This exception indicates that the connection has been gracefully shut down by the server.

The operation call that caused this exception has not been executed by the server. In most cases you will not get this exception, because the client will automatically retry the operation call in case the server shut down the connection. However, if upon retry the server shuts down the connection again, and the retry limit has been reached, then this exception is propagated to the application code.

Constructor & Destructor Documentation

◆ CloseConnectionException() [1/2]

Ice::CloseConnectionException::CloseConnectionException ( const char * file,
int line )

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

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

◆ CloseConnectionException() [2/2]

Ice::CloseConnectionException::CloseConnectionException ( const char * file,
int line,
const ::std::string & reason )

One-shot constructor to initialize all data members.

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

Parameters
fileThe file name in which the exception was raised, typically __FILE__.
lineThe line number at which the exception was raised, typically __LINE__.
reasonThe reason for the failure.

◆ ~CloseConnectionException()

virtual Ice::CloseConnectionException::~CloseConnectionException ( )
throw ( )
virtual

Member Function Documentation

◆ ice_clone()

virtual CloseConnectionException * Ice::CloseConnectionException::ice_clone ( ) const
virtual

Polymorphically clones this exception.

Returns
A shallow copy of this exception.

Reimplemented from Ice::ProtocolException.

◆ ice_id()

virtual::std::string Ice::CloseConnectionException::ice_id ( ) const
virtual

Obtains the Slice type ID of this exception.

Returns
The fully-scoped type ID.

Implements IceUtil::Exception.

◆ ice_print()

virtual void Ice::CloseConnectionException::ice_print ( ::std::ostream & stream) const
virtual

Prints this exception to the given stream.

Parameters
streamThe target stream.

Reimplemented from Ice::ProtocolException.

◆ ice_throw()

virtual void Ice::CloseConnectionException::ice_throw ( ) const
virtual

Throws this exception.

Reimplemented from Ice::ProtocolException.


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