Package com.lightstreamer.client

Interface ClientMessageListener

public interface ClientMessageListener
Interface to be implemented to listen to LightstreamerClient.sendMessage(java.lang.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.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onAbort(String originalMessage, boolean sentOnNetwork)
    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.
    void
    onDeny(String originalMessage, int code, String error)
    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.
    void
    onDiscarded(String originalMessage)
    Event handler that is called by Lightstreamer to notify that the related message has been discarded by the Server.
    void
    onError(String originalMessage)
    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.
    void
    onProcessed(String originalMessage, String response)
    Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.

  • Method Details

    • onAbort

      void onAbort(@Nonnull String originalMessage, boolean sentOnNetwork)
      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.
      Parameters:
      originalMessage - the message to which this notification is related.
      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

      void onDeny(@Nonnull String originalMessage, int code, @Nonnull String error)
      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.
      Parameters:
      originalMessage - the message to which this notification is related.
      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.
      error - the description of the error sent by the Server.

    • onDiscarded

      void onDiscarded(@Nonnull String originalMessage)
      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.
      Parameters:
      originalMessage - the message to which this notification is related.

    • onError

      void onError(@Nonnull String originalMessage)
      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.
      Parameters:
      originalMessage - the message to which this notification is related.

    • onProcessed

      void onProcessed(@Nonnull String originalMessage, @Nonnull String response)
      Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.
      Parameters:
      originalMessage - the message to which this notification is related.
      response - the response from the Metadata Adapter. If not supplied (i.e. supplied as null), an empty message is received here.