Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for Ice::CloseConnectionException:
Collaboration graph
[legend]

Public Member Functions

 CloseConnectionException (const char *file, int line)
 The file and line number are required for all local exceptions. More...
 
 CloseConnectionException (const char *file, int line, const ::std::string &reason)
 One-shot constructor to initialize all data members. More...
 
 CloseConnectionException (const CloseConnectionException &)=default
 
virtual void ice_print (::std::ostream &stream) const override
 Prints this exception to the given stream. More...
 
std::tuple< const ::std::string & > ice_tuple () const
 Obtains a tuple containing all of the exception's data members. More...
 
virtual ~CloseConnectionException ()
 
- Public Member Functions inherited from Ice::LocalExceptionHelper< CloseConnectionException, ProtocolException >
virtual std::string ice_id () const override
 
- Public Member Functions inherited from IceUtil::ExceptionHelper< CloseConnectionException, ProtocolException >
std::unique_ptr< CloseConnectionException > ice_clone () const
 
virtual void ice_throw () const override
 Throws this exception. More...
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this exception. More...
 

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()

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

◆ CloseConnectionException() [1/3]

Ice::CloseConnectionException::CloseConnectionException ( const CloseConnectionException )
default

◆ CloseConnectionException() [2/3]

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

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() [3/3]

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

Member Function Documentation

◆ ice_print()

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

Prints this exception to the given stream.

Parameters
streamThe target stream.

◆ ice_staticId()

static const ::std::string& Ice::CloseConnectionException::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::CloseConnectionException::ice_tuple ( ) const
inline

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

Returns
The data members in a tuple.

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