Package org.jgroups

Interface Receiver

All Known Implementing Classes:

Bridge, Chat, Draw, MyReceiver, RelayDemo, RelayDemoRpc, Relayer2.Bridge, ReplCache, ReplicatedHashMap, ReplicatedTree

public interface Receiver

Defines the callbacks that are invoked when messages, views etc are received

Since:

2.0

Author:

Bela Ban

See Also:

JChannel.setReceiver(Receiver)

Method Summary

Modifier and Type	Method	Description
default void	getState(java.io.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(java.io.InputStream in)	Allows an application to read the state from an InputStream.
default void	viewAccepted(View new_view)	Called when a change in membership has occurred.

Method Detail

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.

getState

default void getState(java.io.OutputStream out)
               throws java.lang.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:

java.lang.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(java.io.InputStream in)
               throws java.lang.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:

java.lang.Exception - If the streaming fails, any exceptions should be thrown so that the state requester can catch them and thus know what happened