class UMDSReceiver is the receiving class for UMDS receivers. Applications shall derive from it to implement their receiving object. Applications must override the onMessage() API to receive data. Separate constructors are defined for regular and wildcard receivers. Applications have the choice of using the wildcard constructor or the UMDSWildcardReceiver class to implement wildcard receivers. More...

Inheritance diagram for com.latencybusters.umds.UMDSReceiver:

Public Member Functions
	UMDSReceiver (UMDSServerConnection sconn, System.String topic)
	This constructor creates a regular receiver object on a UMDS connection. More...

	UMDSReceiver (UMDSServerConnection sconn, System.String topic, bool iswildcard)
	This constructor creates a wildcard receiver object on a UMDS connection when iswildcard is set to true. Applications may alternatively inherit UMDSWildcardReceiver which implicitly calls this constructor. More...

virtual void	onMessage (UMDSMessage msg)
	Message Delivery function. This is called to deliver messages to the application. This should be overridden by applications. Only data messages will be given to onMessage() More...

override void	onEvent (UMDSMessage msg)
	Event Notification function. This function is called when non-data events occur, E.G. Loss reported by the server. This should be overridden by applications. Expected message types: LOSS, DISCONNECT, SERVER_DENIED, RECEIVER_CREATE and RECEIVER_DELETE. More...

override void	onRequest (UMDSMessage msg)
	Callback for request messages received. Implement this method to receive requests. More...

void	close ()
	Close this receiver. The server will send an asynchronous ACK for this operation, queued messages will be received before the ACK is delivered. More...

virtual void	log (int level, System.String comment)
	Log a receiver related message. This API currently does nothing unique, but is provided as an aid to users deriving from the class but may in the future be updated to identify the receiver automatically. More...

Object	getReceiverRecoveryInfoCbArg ()

Detailed Description

class UMDSReceiver is the receiving class for UMDS receivers. Applications shall derive from it to implement their receiving object. Applications must override the onMessage() API to receive data. Separate constructors are defined for regular and wildcard receivers. Applications have the choice of using the wildcard constructor or the UMDSWildcardReceiver class to implement wildcard receivers.

Constructor & Destructor Documentation

com.latencybusters.umds.UMDSReceiver.UMDSReceiver	(	UMDSServerConnection	sconn,
		System.String	topic
	)

This constructor creates a regular receiver object on a UMDS connection.

the UMDS exception

Exceptions

UMDSException

Parameters

sconn	The server connection object this receiver is tied to. This explicitly ties the receiver to a server.
topic	The topic this receiver is receiving on

com.latencybusters.umds.UMDSReceiver.UMDSReceiver	(	UMDSServerConnection	sconn,
		System.String	topic,
		bool	iswildcard
	)

This constructor creates a wildcard receiver object on a UMDS connection when iswildcard is set to true. Applications may alternatively inherit UMDSWildcardReceiver which implicitly calls this constructor.

the UMDS exception

Exceptions

UMDSException

Parameters

sconn	The server connection object this receiver is tied to. This explicitly ties the receiver to a server.
topic	The topic this receiver is receiving on
iswildcard	Indicates this receiver is a wildcard topic

Member Function Documentation

void com.latencybusters.umds.UMDSReceiver.close ( )

Close this receiver. The server will send an asynchronous ACK for this operation, queued messages will be received before the ACK is delivered.

Exceptions

UMDSException When the receiver could not be cleanly deleted

virtual void com.latencybusters.umds.UMDSReceiverBase.log	(	int	level,
		System.String	comment
	)

virtualinherited

Log a receiver related message. This API currently does nothing unique, but is provided as an aid to users deriving from the class but may in the future be updated to identify the receiver automatically.

the UMDS exception

Exceptions

UMDSException

References com.latencybusters.umds.UMDS.log(), and com.latencybusters.umds.UMDSServerConnection.UMDS.

override void com.latencybusters.umds.UMDSReceiver.onEvent ( UMDSMessage msg )

virtual

Event Notification function. This function is called when non-data events occur, E.G. Loss reported by the server. This should be overridden by applications. Expected message types: LOSS, DISCONNECT, SERVER_DENIED, RECEIVER_CREATE and RECEIVER_DELETE.

Parameters

msg	The message containing the event

Implements com.latencybusters.umds.UMDSReceiverBase.

virtual void com.latencybusters.umds.UMDSReceiver.onMessage ( UMDSMessage msg )

virtual

Message Delivery function. This is called to deliver messages to the application. This should be overridden by applications. Only data messages will be given to onMessage()

See also: M:onEvent

Parameters

msg	The message containing the received data

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

override void com.latencybusters.umds.UMDSReceiver.onRequest ( UMDSMessage msg )

virtual

Callback for request messages received. Implement this method to receive requests.

Parameters

msg	The type for request messages is REQUEST. All UMDSMessage interfaces that are valid for DATA messages are also valid for request messages. The requestID is undefined for received requests, as it is a source-side-only correlation ID.

Implements com.latencybusters.umds.UMDSReceiverBase.

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

UMDSReceiver.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation