Interface OutgoingMessageQueue

All Known Implementing Classes:
OutgoingMessageQueueImpl
public interface OutgoingMessageQueue
Queue for sending outgoing messages.

  • Method Details

    • setEncoder

      void setEncoder(MessageStreamEncoder encoder)
      Set the message stream encoder that will be used to encode outgoing messages.
      Parameters:
      encoder - to use

    • sendMessage

      void sendMessage(Message message)
      Queue the given message for sending.
      Parameters:
      message - to send

    • registerListener

      void registerListener(OutgoingMessageQueueListener listener)
      Register queue listener.
      Parameters:
      listener - to register

    • deregisterListener

      void deregisterListener(OutgoingMessageQueueListener listener)
      Remove registration of queue listener.
      Parameters:
      listener - to remove

    • notifyOfExternalSend

      void notifyOfExternalSend(Message message)
      Notifty the queue (and its listeners) of a message sent externally on the queue's behalf.
      Parameters:
      message - sent externally

    • getPercentDoneOfCurrentMessage

      default int getPercentDoneOfCurrentMessage()

    • getCurrentMessageProgress

      int[] getCurrentMessageProgress()

    • getDataQueuedBytes

      int getDataQueuedBytes()

    • getProtocolQueuedBytes

      int getProtocolQueuedBytes()

    • isBlocked

      boolean isBlocked()