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

Classes

class  MSG_STATUS
 
class  MSG_TYPE
 

Public Member Functions

int length ()
 
String toString ()
 
void respond (byte[] response_msg) throws UMDSException
 

Public Attributes

int type
 
long seqnum = 0
 
long low_seqnum = 0
 
long srcidx = -1
 
int status = 0
 
boolean recovered = false
 
String status_str = null
 
byte[] appdata = null
 
boolean appmetadata_present
 
int appmeta_data
 
int requestID
 
int compress_orig_data_len
 
byte[] response_data
 
UMDSServerConnection server
 
String topic
 
long source_session_id = -1
 

Detailed Description

class UMDSMessage is the main message class for UMDS clients. Application data is sent or received using UMDSMessage objects

Member Function Documentation

int com.latencybusters.umds.UMDSMessage.length ( )

Get the length of the message.

Returns
The length of the message

Referenced by com.latencybusters.umds.UMDSPersistentReceiver.onMessage(), and com.latencybusters.umds.UMDSReceiver.onMessage().

void com.latencybusters.umds.UMDSMessage.respond ( byte []  response_msg) throws UMDSException

Send a response to a request. Multiple responses may be sent for the same request.

Parameters
response_msgUser specified response data.
Exceptions
UMDSExceptionThe same exceptions as the send() method, and additionally: UMDS.UMDSBadStateException - if called on a message not of REQUEST type

Member Data Documentation

byte [] com.latencybusters.umds.UMDSMessage.appdata = null

The application data

Referenced by com.latencybusters.umds.UMDSServerConnection.send().

int com.latencybusters.umds.UMDSMessage.appmeta_data

Application meta data

Referenced by com.latencybusters.umds.UMDSServerConnection.send().

boolean com.latencybusters.umds.UMDSMessage.appmetadata_present

Indicates if Application data was received

long com.latencybusters.umds.UMDSMessage.low_seqnum = 0

The low sequence number of this message. This will be the low sequence number for messages fragmented in the LBM backbone

Referenced by com.latencybusters.umds.UMDSServerConnection.send().

boolean com.latencybusters.umds.UMDSMessage.recovered = false

Indicates the message was created as part of a recovery operation (late join etc)

int com.latencybusters.umds.UMDSMessage.requestID

Request ID for correlating events to a sent request. The request ID is not valid for REQUEST messages. It is only populated in responses and timeout events for the requester.

Referenced by com.latencybusters.umds.UMDSSource.onEvent(), and com.latencybusters.umds.UMDSMessage.toString().

byte [] com.latencybusters.umds.UMDSMessage.response_data

Response Data to be returned to the server when responding

long com.latencybusters.umds.UMDSMessage.seqnum = 0
long com.latencybusters.umds.UMDSMessage.source_session_id = -1

Source session ID for persistent receiver

String com.latencybusters.umds.UMDSMessage.topic

The topic this message is associated with.


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