All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::IServerError Struct Referenceabstract

Provides details about errors that occur during server interactions. More...

#include <IServerError.h>

Inheritance diagram for Glympse::IServerError:
Inheritance graph
[legend]

Public Member Functions

virtual int32 getType ()=0
 Returns the type of error that occurred. More...
 
virtual GString getError ()=0
 Returns the name of the error that occurred. More...
 
virtual GCommonObj getExtraParam ()=0
 Returns the extra param associated with the error that occurred. More...
 
Debug Tools

These tools are provided for debugging purposes only and should never be invoked from production code.

virtual GString getErrorDetails ()=0
 Returns details about the error that occurred. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

Provides details about errors that occur during server interactions.

Member Function Documentation

virtual GString Glympse::IServerError::getError ( )
pure virtual

Returns the name of the error that occurred.

Returns
A string describing the error.
virtual GString Glympse::IServerError::getErrorDetails ( )
pure virtual

Returns details about the error that occurred.

Returns
A string containing specifics regarding the cause of the error.
virtual GCommonObj Glympse::IServerError::getExtraParam ( )
pure virtual

Returns the extra param associated with the error that occurred.

Returns
An object whose type is dependent on the type of error.
virtual int32 Glympse::IServerError::getType ( )
pure virtual

Returns the type of error that occurred.

Returns
An error code defined in a GC::SERVER_ERROR constant.

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