Class MessageListener

Object
   |
   +--MessageListener

class MessageListener

Class suitable for creating listeners to be supplied to LightstreamerEngine.sendMessage().
Defined in lscommons.js

Constructor Detail

MessageListener

MessageListener()

Creates a void listener that can be supplied to LightstreamerEngine.sendMessage() together with a message. The object methods, initially no-op's, can be replaced to manage notifications about the processing outcome of the related message.

onAbort

void onAbort()

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.

Default implementation: do nothing

onDeny

void onDeny(<Number> code, <String> message)

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.

Default implementation: do nothing

Parameters:
code - The error code sent by the Server. It can be one of the following:
• <= 0 - the Metadata Adapter has refused the message; the code value is dependent on the specific Metadata Adapter implementation
message - The description of the error sent by the Server.

onDiscarded

void onDiscarded()

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.

Default implementation: do nothing

onError

void onError()

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.

Default implementation: do nothing

onProcessed

void onProcessed()

Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.

Default implementation: do nothing