Package org.jgroups

Interface Receiver

All Known Implementing Classes:
Bridge, Chat, Draw, FlowControlTest, JGroupsTransport, LargeState, MessageDispatcherSpeedTest, MessageSendTest, MPerf, MPerfRpc, MyReceiver, PingPong, ProgrammaticUPerf, ProgrammaticUPerf2, RelayDemo, RelayDemoRpc, Relayer2.Bridge, ReplCache, ReplicatedHashMap, ReplicatedTree, RoundTripRpc, RpcDispatcherBlocking, RpcDispatcherSpeedTest, UnicastTest.MyReceiver, UnicastTestRpc, UPerf
public interface Receiver
Defines the callbacks that are invoked when messages, views etc are received
Since:
2.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    block()
    Called (usually by the FLUSH protocol), as an indication that the member should stop sending messages.
    default void
    getState(OutputStream out)
    Allows an application to write the state to an OutputStream.
    default void
    receive(Message msg)
    Called when a message is received.
    default void
    receive(MessageBatch batch)
    Called when a batch of messages is received
    default void
    setState(InputStream in)
    Allows an application to read the state from an InputStream.
    default void
    unblock()
    Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again.
    default void
    viewAccepted(View new_view)
    Called when a change in membership has occurred.

  • Method Details

    • receive

      default void receive(Message msg)
      Called when a message is received.
      Parameters:
      msg - The message

    • receive

      default void receive(MessageBatch batch)
      Called when a batch of messages is received
      Parameters:
      batch - The message batch

    • viewAccepted

      default void viewAccepted(View new_view)
      Called when a change in membership has occurred. No long running actions, sending of messages or anything that could block should be done in this callback. If some long running action needs to be performed, it should be done in a separate thread.

      Note that on reception of the first view (a new member just joined), the channel will not yet be in the connected state. This only happens when JChannel.connect(String) returns.

    • block

      default void block()
      Called (usually by the FLUSH protocol), as an indication that the member should stop sending messages. Any messages sent after returning from this callback might get blocked by the FLUSH protocol. When the FLUSH protocol is done, and messages can be sent again, the FLUSH protocol will simply unblock all pending messages. If a callback for unblocking is desired, implement unblock().

    • unblock

      default void unblock()
      Called after the FLUSH protocol has unblocked previously blocked senders, and messages can be sent again.

      Note that during new view installation we provide guarantee that unblock invocation strictly follows view installation at some node A belonging to that view. However, some other message M may squeeze in between view and unblock callbacks.

      For more details see JGRP-986

    • getState

      default void getState(OutputStream out) throws Exception
      Allows an application to write the state to an OutputStream. After the state has been written, the OutputStream doesn't need to be closed as stream closing is automatically done when a calling thread returns from this callback.
      Parameters:
      out - The OutputStream
      Throws:
      Exception - If the streaming fails, any exceptions should be thrown so that the state requester can re-throw them and let the caller know what happened

    • setState

      default void setState(InputStream in) throws Exception
      Allows an application to read the state from an InputStream. After the state has been read, the InputStream doesn't need to be closed as stream closing is automatically done when a calling thread returns from this callback.
      Parameters:
      in - The InputStream
      Throws:
      Exception - If the streaming fails, any exceptions should be thrown so that the state requester can catch them and thus know what happened