class UMDSSourceBase is the collection of common functionality for all UMDS Source classes. It is purely internal. More...
Public Member Functions | |
| bool | canSend () |
| abstract void | onEvent (UMDSMessage msg) |
| Every Source must handle events such as errors. More... | |
| abstract void | onResponse (UMDSMessage msg) |
| Source handle responses. 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... | |
| abstract void | send (byte[] data) |
| Send an array of data. More... | |
| virtual void | request (int request_id, byte[] request_data) |
| Send a request on a source topic. Requests and responses are not reliable (they may be lost), so it is expected that an application will periodically send new requests until satisfied with the responses received. More... | |
Detailed Description
class UMDSSourceBase is the collection of common functionality for all UMDS Source classes. It is purely internal.
Member Function Documentation
|
virtual |
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.
|
pure virtual |
Every Source must handle events such as errors.
- Parameters
-
msg The message containing an event
Implemented in com.latencybusters.umds.UMDSSource.
|
pure virtual |
Source handle responses.
- Parameters
-
msg The message containing an event
Implemented in com.latencybusters.umds.UMDSSource.
Referenced by com.latencybusters.umds.UMDSServerThread.UMDSServerThread().
|
virtual |
Send a request on a source topic. Requests and responses are not reliable (they may be lost), so it is expected that an application will periodically send new requests until satisfied with the responses received.
- Exceptions
-
The same exceptions as the send() method, with no additional exception cases.
- Parameters
-
request_id User defined and maintained id for this request. Responses and timeout notifications will reference this id. Any 32-bit signed integer value is valid. The same value can be used for multiple requests but this is not recommended as its purpose is to assist in correlating responses to each request. request_data User specified request data.
|
pure virtual |
Send an array of data.
- Parameters
-
data The data to be sent
Implemented in com.latencybusters.umds.UMDSSource.
The documentation for this class was generated from the following file:
- UMDSSourceBase.cs
