Package org.jgroups.protocols

Class SHUFFLE

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.SHUFFLE

All Implemented Interfaces:

Lifecycle

public class SHUFFLE
extends Protocol

Reorders messages by buffering them and shuffling the result after TIMEOUT ms.

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	down
protected java.util.concurrent.locks.Lock	down_lock
protected java.util.List<Message>	down_msgs
protected int	max_size
protected long	max_time
protected java.util.concurrent.Future<?>	task
protected TimeScheduler	timer
protected boolean	up
protected java.util.concurrent.locks.Lock	up_lock
protected java.util.List<Message>	up_msgs

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
SHUFFLE()

Method Summary

Modifier and Type	Method	Description
protected SHUFFLE	add(java.util.List<Message> queue, Message msg, java.util.concurrent.locks.Lock lock, java.util.function.Consumer<Message> send_function)
void	destroy()	This method is called on a JChannel.close().
java.lang.Object	down(Message msg)	A message is sent down the stack.
void	flush(boolean stop_shuffling)
int	getDownMessages()
int	getMaxSize()
long	getMaxTime()
int	getUpMessages()
void	init()	Called after a protocol has been created and before the protocol is started.
boolean	isDown()
boolean	isUp()
protected SHUFFLE	reorderAndSend(java.util.List<Message> list, java.util.concurrent.locks.Lock lock, java.util.function.Consumer<Message> send_function)
SHUFFLE	setDown(boolean down)
SHUFFLE	setMaxSize(int max_size)
SHUFFLE	setMaxTime(long max_time)
SHUFFLE	setUp(boolean up)
void	start()	This method is called on a JChannel.connect(String); starts work.
protected void	startTask()
void	stop()	Called on a JChannel.disconnect(); stops work (e.g.
void	stopTask()
java.lang.Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString, up

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

timer

protected TimeScheduler timer

up_msgs

protected java.util.List<Message> up_msgs

down_msgs

protected java.util.List<Message> down_msgs

up_lock

protected final java.util.concurrent.locks.Lock up_lock

down_lock

protected final java.util.concurrent.locks.Lock down_lock

task

protected java.util.concurrent.Future<?> task

up

protected volatile boolean up

down

protected volatile boolean down

max_size

protected int max_size

max_time

protected long max_time

Constructor Detail

SHUFFLE

public SHUFFLE()

Method Detail

getUpMessages

public int getUpMessages()

getDownMessages

public int getDownMessages()

isUp

public boolean isUp()

setUp

public SHUFFLE setUp(boolean up)

isDown

public boolean isDown()

setDown

public SHUFFLE setDown(boolean down)

getMaxSize

public int getMaxSize()

setMaxSize

public SHUFFLE setMaxSize(int max_size)

getMaxTime

public long getMaxTime()

setMaxTime

public SHUFFLE setMaxTime(long max_time)

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.

Specified by:

init in interface Lifecycle

Overrides:

init in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.

Specified by:

start in interface Lifecycle

Overrides:

start in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) will throw an exception

stop

public void stop()

Description copied from class: Protocol

Called on a JChannel.disconnect(); stops work (e.g. by closing multicast socket). Will be called from top to bottom.

Specified by:

stop in interface Lifecycle

Overrides:

stop in class Protocol

destroy

public void destroy()

Description copied from class: Protocol

This method is called on a JChannel.close(). Does some cleanup; after the call, the VM will terminate

Specified by:

destroy in interface Lifecycle

Overrides:

destroy in class Protocol

down

public java.lang.Object down(Message msg)

Description copied from class: Protocol

A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it, before passing it down.

Overrides:

down in class Protocol

up

public java.lang.Object up(Message msg)

Description copied from class: Protocol

A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.iterator(Predicate)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

Overrides:

up in class Protocol

Parameters:

batch - The message batch

flush

public void flush(boolean stop_shuffling)

startTask

protected void startTask()

stopTask

public void stopTask()

add

protected SHUFFLE add(java.util.List<Message> queue,
                      Message msg,
                      java.util.concurrent.locks.Lock lock,
                      java.util.function.Consumer<Message> send_function)

reorderAndSend

protected SHUFFLE reorderAndSend(java.util.List<Message> list,
                                 java.util.concurrent.locks.Lock lock,
                                 java.util.function.Consumer<Message> send_function)