Ice 3.7 C++98 API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 UnknownUserExceptionice_clone () const
 Polymorphically clones this exception. More...
 
virtual ::std::string ice_id () const
 Obtains the Slice type ID of this exception. More...
 
virtual void ice_print (::std::ostream &stream) const
 Prints this exception to the given stream. More...
 
virtual void ice_throw () const
 Throws this exception. 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...
 
virtual ~UnknownUserException () throw ()
 
- Public Member Functions inherited from Ice::UnknownException
 UnknownException (const char *file, int line)
 The file and line number are required for all local exceptions. More...
 
 UnknownException (const char *file, int line, const ::std::string &unknown)
 One-shot constructor to initialize all data members. More...
 
virtual ~UnknownException () 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. More...
 
virtual ~LocalException () throw ()
 
- Public Member Functions inherited from IceUtil::Exception
 Exception ()
 Constructs the exception. More...
 
 Exception (const char *file, int line)
 Constructs the exception. More...
 
const char * ice_file () const
 Returns the name of the file where this exception was constructed. More...
 
int ice_line () const
 Returns the line number where this exception was constructed. More...
 
std::string ice_name () const
 
virtual void ice_print (std::ostream &os) const
 Outputs a description of this exception to a stream. More...
 
std::string ice_stackTrace () const
 Returns the stack trace at the point this exception was constructed. More...
 
virtual const char * what () const throw ()
 Returns a description of this exception. More...
 
virtual ~Exception ()=0 throw ()
 

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. More...
 
- Public Attributes inherited from Ice::UnknownException
::std::string unknown
 This field is set to the textual representation of the unknown exception if available. 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() [1/2]

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

◆ UnknownUserException() [2/2]

Ice::UnknownUserException::UnknownUserException ( const char *  file,
int  line,
const ::std::string &  unknown 
)

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.

◆ ~UnknownUserException()

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

Member Function Documentation

◆ ice_clone()

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

Polymorphically clones this exception.

Returns
A shallow copy of this exception.

Reimplemented from Ice::UnknownException.

◆ ice_id()

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

Obtains the Slice type ID of this exception.

Returns
The fully-scoped type ID.

Reimplemented from Ice::UnknownException.

◆ ice_print()

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

Prints this exception to the given stream.

Parameters
streamThe target stream.

Reimplemented from Ice::UnknownException.

◆ ice_throw()

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

Throws this exception.

Reimplemented from Ice::UnknownException.


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