UMDS .NET API  6.12
com.latencybusters.umds.UMDSMessage Class Reference

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

Classes

class  MSG_STATUS
 Ancillary status where applicable. More...
 
class  MSG_TYPE
 The types of data in a UMDSMessage. More...
 

Public Member Functions

virtual int length ()
 Get the length of the message. More...
 
override System.String ToString ()
 Get the string version of this message.
 
void respond (byte[] response_msg)
 Send a response to a request. Multiple responses may be sent for the same request. More...
 

Public Attributes

int type
 The type of data in this message. More...
 
long seqnum = 0
 The sequence number of this message. This will be the high sequence number for messages fragmented in the LBM backbone.
 
long low_seqnum = 0
 The low sequence number of this message. This will be the low sequence number for messages fragmented in the LBM backbone.
 
long srcidx = - 1
 The UMDS server index of the source.
 
int status = 0
 The server status relating to this message. Only used with DISCONNECT type messages.
 
bool recovered = false
 Indicates the message was created as part of a recovery operation (late join etc)
 
System.String status_str = null
 The server status string. More...
 
byte[] appdata = null
 The application data.
 
bool appmetadata_present
 Indicates if Application data was received.
 
int appmeta_data
 Application meta data.
 
int 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.
 
sbyte[] response_data
 Response Data to be returned to the server when responding.
 
UMDSServerConnection server
 
System.String topic
 The topic this message is associated with.
 

Detailed Description

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

Member Function Documentation

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

Get the length of the message.

Returns
The length of the message

Referenced by com.latencybusters.umds.UMDSReceiver.onMessage().

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

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

The same exceptions as the send() method, and additionally: UMDS.UMDSBadStateException - if called on a message not of REQUEST type

Parameters
response_msgUser specified response data.

Member Data Documentation


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