Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Ice::ConnectionManuallyClosedException Class Reference

This exception is raised by an operation call if the application closes the connection locally using Connection#close. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::ConnectionManuallyClosedException:
Inheritance graph
[legend]
Collaboration diagram for Ice::ConnectionManuallyClosedException:
Collaboration graph
[legend]

Public Member Functions

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

Public Attributes

bool graceful
 True if the connection was closed gracefully, false otherwise. More...
 

Detailed Description

This exception is raised by an operation call if the application closes the connection locally using Connection#close.

See also
Connection::close

Constructor & Destructor Documentation

◆ ~ConnectionManuallyClosedException()

virtual Ice::ConnectionManuallyClosedException::~ConnectionManuallyClosedException ( )
virtual

◆ ConnectionManuallyClosedException() [1/3]

Ice::ConnectionManuallyClosedException::ConnectionManuallyClosedException ( const ConnectionManuallyClosedException )
default

◆ ConnectionManuallyClosedException() [2/3]

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

◆ ConnectionManuallyClosedException() [3/3]

Ice::ConnectionManuallyClosedException::ConnectionManuallyClosedException ( const char *  file,
int  line,
bool  graceful 
)
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__.
gracefulTrue if the connection was closed gracefully, false otherwise.

Member Function Documentation

◆ ice_print()

virtual void Ice::ConnectionManuallyClosedException::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::ConnectionManuallyClosedException::ice_staticId ( )
static

Obtains the Slice type ID of this exception.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const bool&> Ice::ConnectionManuallyClosedException::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

◆ graceful

bool Ice::ConnectionManuallyClosedException::graceful

True if the connection was closed gracefully, false otherwise.


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