UMDS Java API  6.14
com.latencybusters.umds.UMDS Class Reference

Inherited by com.latencybusters.umds.UMDSTestApp.xUMDS.

Classes

class  DEBUG_FLAG
 
class  ERRCODE
 
class  LOG_LEVEL
 
class  UMDSAuthenticationException
 
class  UMDSBadStateException
 
class  UMDSCapabilitiesException
 
class  UMDSDisconnectException
 
class  UMDSException
 
class  UMDSNoDataException
 
class  UMDSPermissionsException
 
class  UMDSReadTimeoutException
 

Public Member Functions

 UMDS ()
 
void log (int level, String comment)
 
synchronized final void close () throws UMDSException
 
final void setDebugLocation (String LocationString) throws UMDSException
 
final void SetDebugMask (long mask) throws UMDSException
 

Static Public Member Functions

static String version ()
 

Detailed Description

Base functionality for UMDS clients.

Constructor & Destructor Documentation

com.latencybusters.umds.UMDS.UMDS ( )

Constructor for base UMDS class. Currently empty.

References com.latencybusters.umds.UMDS.log().

Member Function Documentation

synchronized final void com.latencybusters.umds.UMDS.close ( ) throws UMDSException

Terminate a UMDS global object and all references to it.

Exceptions
UMDSExceptionthe UMDS exception
void com.latencybusters.umds.UMDS.log ( int  level,
String  comment 
)

Log a message with a given log level. Applications can override this method if they need to add log level control. By default, all logs are output to System.err. log() can be called even after close()

Parameters
levelThe level of the log comment (LOG_LEVEL)
commentThe comment to be logged
See also
LOG_LEVEL

References com.latencybusters.umds.UMDS.LOG_LEVEL.CRITICAL, com.latencybusters.umds.UMDS.LOG_LEVEL.INFO, and com.latencybusters.umds.UMDS.LOG_LEVEL.WARN.

Referenced by com.latencybusters.umds.UMDSServerConnection.getUMDS(), and com.latencybusters.umds.UMDS.UMDS().

final void com.latencybusters.umds.UMDS.setDebugLocation ( String  LocationString) throws UMDSException

Set the location debug out put should sent.

Parameters
LocationStringthe location string
Exceptions
UMDSExceptionthe UMDS exception

References com.latencybusters.umds.UMDS.version().

final void com.latencybusters.umds.UMDS.SetDebugMask ( long  mask) throws UMDSException

Set the debug level. This is used in cooperation with support.

Parameters
maskThe debug mask.
Exceptions
UMDSExceptionthe UMDS exception
static String com.latencybusters.umds.UMDS.version ( )
static

Get the version string.

Referenced by com.latencybusters.umds.UMDS.setDebugLocation().


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