Photon C++ Client API  4.1.15.3
Public Member Functions | Static Public Member Functions | List of all members
Base Class Reference
Inheritance diagram for Base:
Inheritance graph
[legend]
Collaboration diagram for Base:
Collaboration graph
[legend]

Public Member Functions

virtual ~Base (void)
 
- Public Member Functions inherited from ToString
virtual ~ToString (void)
 
virtual JString typeToString (void) const
 
virtual JStringtoString (JString &retStr, bool withTypes=false) const =0
 
JString toString (bool withTypes=false) const
 

Static Public Member Functions

static void setListener (const BaseListener *baseListener)
 
static int getDebugOutputLevel (void)
 
static bool setDebugOutputLevel (int debugLevel)
 
static const LogFormatOptionsgetLogFormatOptions (void)
 
static void setLogFormatOptions (const LogFormatOptions &options)
 

Detailed Description

This is the base-class of all Utility-classes except of JString.

This class provides a common callback interface for transmitting debug messages from all utility classes to your application. Please refer to setListener() for more information.

See also
BaseListener , setListener()

Constructor & Destructor Documentation

§ ~Base()

~Base ( void  )
virtual

Destructor.

Member Function Documentation

§ setListener()

void setListener ( const BaseListener baseListener)
static

Registers a listener for receiving debug information from the Exitgames Utility classes.

Please refer to BaseListener for more information and a code example.

Parameters
baseListenerThe listener, in which you want to receive the the events. Has to be a pointer to a class derived from BaseListener.
See also
BaseListener

§ getDebugOutputLevel()

int getDebugOutputLevel ( void  )
static

Returns the current level of debug information that's passed on to BaseListener::debugReturn().

Returns
one of the values in DebugLevel
See also
setDebugOutputLevel()

§ setDebugOutputLevel()

bool setDebugOutputLevel ( int  debugLevel)
static

Sets the current level of debug information that's passed on to BaseListener::debugReturn().

Parameters
debugLevelone of the values in DebugLevel
Returns
true if the new debug level has been set correctly, false otherwise.
See also
getDebugOutputLevel()

§ getLogFormatOptions()

const LogFormatOptions & getLogFormatOptions ( void  )
static

Returns
the LogFormatOptions that are used by this instance.
See also
setFormatOptions()

§ setLogFormatOptions()

void setLogFormatOptions ( const LogFormatOptions formatOptions)
static

Sets the log format options to the supplied value.

Parameters
formatOptionsthe new value to which the log format options will be set
See also
getFormatOptions()