Interface ClientMessageListener
Interface to be implemented to listen to LightstreamerClient.sendMessage(string)
events reporting a message processing outcome.
Events for these listeners are dispatched by a different thread than the one that generates them.
All the notifications for a single LightstreamerClient, including notifications to
ClientListeners, SubscriptionListeners and ClientMessageListeners will be dispatched by the
same thread.
Only one event per message is fired on this listener.
Namespace: com.lightstreamer.client
Assembly: Lightstreamer.DotNetStandard.Client.Api.dll
Syntax
public interface ClientMessageListener
Methods
onAbort(string, bool)
Event handler that is called by Lightstreamer when any notifications of the processing outcome of the related message haven't been received yet and can no longer be received. Typically, this happens after the session has been closed. In this case, the client has no way of knowing the processing outcome and any outcome is possible.
Declaration
void onAbort(string originalMessage, bool sentOnNetwork)
Parameters
Type | Name | Description |
---|---|---|
string | originalMessage | the message to which this notification is related. |
bool | sentOnNetwork | true if the message was sent on the network, false otherwise. Even if the flag is true, it is not possible to infer whether the message actually reached the Lightstreamer Server or not. |
onDeny(string, int, string)
Event handler that is called by Lightstreamer when the related message has been processed by the Server but the expected processing outcome could not be achieved for any reason.
Declaration
void onDeny(string originalMessage, int code, string error)
Parameters
Type | Name | Description |
---|---|---|
string | originalMessage | the message to which this notification is related. |
int | code | the error code sent by the Server. It can be one of the following:
|
string | error | the description of the error sent by the Server. |
onDiscarded(string)
Event handler that is called by Lightstreamer to notify that the related message has been discarded by the Server. This means that the message has not reached the Metadata Adapter and the message next in the sequence is considered enabled for processing.
Declaration
void onDiscarded(string originalMessage)
Parameters
Type | Name | Description |
---|---|---|
string | originalMessage | the message to which this notification is related. |
onError(string)
Event handler that is called by Lightstreamer when the related message has been processed by the Server but the processing has failed for any reason. The level of completion of the processing by the Metadata Adapter cannot be determined.
Declaration
void onError(string originalMessage)
Parameters
Type | Name | Description |
---|---|---|
string | originalMessage | the message to which this notification is related. |
onProcessed(string, string)
Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.
Declaration
void onProcessed(string originalMessage, string response)
Parameters
Type | Name | Description |
---|---|---|
string | originalMessage | the message to which this notification is related. |
string | response | the response from the Metadata Adapter. If not supplied (i.e. supplied as null), an empty message is received here. |