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

An operation raised an incorrect user exception. More...

#include <Ice/Ice.h>

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

Public Member Functions

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

An operation raised an incorrect user exception.

This exception is raised if an operation raises a user exception that is not declared in the exception's throws clause. Such undeclared exceptions are not transmitted from the server to the client by the Ice protocol, but instead the client just gets an UnknownUserException. This is necessary in order to not violate the contract established by an operation's signature: Only local exceptions and user exceptions declared in the throws clause can be raised.

Constructor & Destructor Documentation

◆ ~UnknownUserException()

virtual Ice::UnknownUserException::~UnknownUserException ( )
virtual

◆ UnknownUserException() [1/3]

Ice::UnknownUserException::UnknownUserException ( const UnknownUserException )
default

◆ UnknownUserException() [2/3]

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

◆ UnknownUserException() [3/3]

Ice::UnknownUserException::UnknownUserException ( const char *  file,
int  line,
const ::std::string &  unknown 
)
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__.
unknownThis field is set to the textual representation of the unknown exception if available.

Member Function Documentation

◆ ice_print()

virtual void Ice::UnknownUserException::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::UnknownUserException::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::UnknownUserException::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: