org.jgroups.protocols.SHUFFLE Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
The newest version!
package org.jgroups.protocols;
import org.jgroups.Message;
import org.jgroups.annotations.ManagedOperation;
import org.jgroups.annotations.Property;
import org.jgroups.conf.AttributeType;
import org.jgroups.stack.Protocol;
import org.jgroups.util.MessageBatch;
import org.jgroups.util.TimeScheduler;
import org.jgroups.util.Util;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Consumer;
/**
* Reorders messages by buffering them and shuffling the result after TIMEOUT ms.
* @author Bela Ban
*
*/
public class SHUFFLE extends Protocol {
protected TimeScheduler timer;
protected List up_msgs;
protected List down_msgs;
protected final Lock up_lock=new ReentrantLock();
protected final Lock down_lock=new ReentrantLock();
protected Future task;
@Property(description="Reorder up messages and message batches")
protected boolean up=true;
@Property(description="Reorder down messages and message batches")
protected boolean down;
@Property(description="max number of messages before we reorder queued messages and send them up")
protected int max_size=10;
@Property(description="max time (in millis) before we pass the reordered messages up or down",type=AttributeType.TIME)
protected long max_time=1500L;
public int getUpMessages() {return up_msgs.size();}
public int getDownMessages() {return down_msgs.size();}
public boolean isUp() {return up;}
public SHUFFLE setUp(boolean up) {this.up=up; return this;}
public boolean isDown() {return down;}
public SHUFFLE setDown(boolean down) {this.down=down; return this;}
public int getMaxSize() {return max_size;}
public SHUFFLE setMaxSize(int max_size) {this.max_size=max_size; return this;}
public long getMaxTime() {return max_time;}
public SHUFFLE setMaxTime(long max_time) {this.max_time=max_time; return this;}
public void init() throws Exception {
super.init();
up_msgs=new ArrayList<>(max_size);
down_msgs=new ArrayList<>(max_size);
}
public void start() throws Exception {
super.start();
timer=getTransport().getTimer();
}
public void stop() {
super.stop();
stopTask();
}
public void destroy() {
super.destroy();
stopTask();
}
public Object down(Message msg) {
Protocol dn_prot=down_prot;
if(dn_prot == null)
return null;
if(!down)
return dn_prot.down(msg);
add(down_msgs, msg, down_lock, dn_prot::down);
return null;
}
public Object up(Message msg) {
Protocol up_protocol=up_prot;
if(up_protocol == null)
return null;
if(!up)
return up_protocol.up(msg);
add(up_msgs, msg, up_lock, m -> up_protocol.up(msg));
return null;
}
public void up(MessageBatch batch) {
if(!up) {
up_prot.up(batch);
return;
}
if(batch.size() > 1) {
shuffle(batch);
if(!batch.isEmpty())
up_prot.up(batch);
}
else
add(up_msgs, batch, up_lock, m -> up_prot.up(m));
}
@ManagedOperation(description="Flushes all pending up and down messages. Optionally disables shuffling")
public void flush(boolean stop_shuffling) {
up_lock.lock();
try {
if(stop_shuffling)
up=false;
up_msgs.forEach(msg -> up_prot.up(msg));
up_msgs.clear();
}
finally {
up_lock.unlock();
}
down_lock.lock();
try {
if(stop_shuffling)
down=false;
down_msgs.forEach(msg -> down_prot.down(msg));
down_msgs.clear();
}
finally {
down_lock.unlock();
}
}
protected static void shuffle(MessageBatch batch) {
Message[] msgs=batch.stream().toArray(Message[]::new);
Util.shuffle(msgs, 0, msgs.length);
batch.array().set(msgs);
}
protected synchronized void startTask() {
if(task == null || task.isDone() || task.isCancelled())
task=timer.schedule(() -> {
reorderAndSend(up_msgs, up_lock, msg -> up_prot.up(msg));
reorderAndSend(down_msgs, down_lock, msg -> down_prot.down(msg));
},
max_time, TimeUnit.MILLISECONDS);
}
public synchronized void stopTask() {
if(task != null)
task.cancel(false);
}
protected SHUFFLE add(List queue, Message msg, Lock lock, Consumer send_function) {
lock.lock();
try {
queue.add(msg);
if(queue.size() >= max_size)
reorderAndSend(queue, lock, send_function); // clears queue
else
startTask();
return this;
}
finally {
lock.unlock();
}
}
protected SHUFFLE add(List queue, MessageBatch batch, Lock lock, Consumer send_function) {
lock.lock();
try {
for(Message msg: batch)
queue.add(msg); // queue can become a bit larger as a result of adding the entire batch
if(queue.size() >= max_size)
reorderAndSend(queue, lock, send_function); // clears queue
return this;
}
finally {
lock.unlock();
}
}
protected SHUFFLE reorderAndSend(List list, final Lock lock, Consumer send_function) {
lock.lock();
try {
Collections.shuffle(list);
list.forEach(send_function);
list.clear();
return this;
}
finally {
lock.unlock();
}
}
}