Package org.jgroups.protocols
Class MAKE_BATCH
- java.lang.Object
-
- org.jgroups.stack.Protocol
-
- org.jgroups.protocols.MAKE_BATCH
-
public class MAKE_BATCH extends Protocol
Intercepts individual up messages and creates batches from them, passing the batches up. Used by unit tests, not meant to be used in production.- Since:
- 3.5
- Author:
- Bela Ban
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
MAKE_BATCH.Batcher
-
Field Summary
Fields Modifier and Type Field Description protected java.util.concurrent.Future<?>
batcher
protected AsciiString
cluster_name
protected Address
local_addr
protected boolean
multicasts
protected java.util.Map<Address,java.util.List<Message>>
oob_map_mcast
protected java.util.Map<Address,java.util.List<Message>>
oob_map_ucast
protected java.util.Map<Address,java.util.List<Message>>
reg_map_mcast
protected java.util.Map<Address,java.util.List<Message>>
reg_map_ucast
protected long
sleep_time
protected TimeScheduler
timer
protected boolean
unicasts
-
Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, log, stack, stats, up_prot
-
-
Constructor Summary
Constructors Constructor Description MAKE_BATCH()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
down(Event evt)
An event is to be sent down the stack.MAKE_BATCH
localAddress(Address a)
MAKE_BATCH
multicasts(boolean flag)
protected void
queue(Message msg)
MAKE_BATCH
sleepTime(long time)
void
start()
This method is called on aJChannel.connect(String)
.void
startBatcher()
void
stop()
This method is called on aJChannel.disconnect()
.protected void
stopBatcher()
MAKE_BATCH
unicasts(boolean flag)
java.lang.Object
up(Message msg)
A single message was received.void
up(MessageBatch batch)
Sends up a multiple messages in aMessageBatch
.-
Methods inherited from class org.jgroups.stack.Protocol
accept, afterCreationHook, destroy, down, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, up
-
-
-
-
Field Detail
-
multicasts
protected boolean multicasts
-
unicasts
protected boolean unicasts
-
sleep_time
protected long sleep_time
-
timer
protected TimeScheduler timer
-
cluster_name
protected AsciiString cluster_name
-
local_addr
protected Address local_addr
-
batcher
protected java.util.concurrent.Future<?> batcher
-
-
Method Detail
-
localAddress
public MAKE_BATCH localAddress(Address a)
-
multicasts
public MAKE_BATCH multicasts(boolean flag)
-
unicasts
public MAKE_BATCH unicasts(boolean flag)
-
sleepTime
public MAKE_BATCH sleepTime(long time)
-
start
public void start() throws java.lang.Exception
Description copied from class:Protocol
This method is called on aJChannel.connect(String)
. Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.- Overrides:
start
in classProtocol
- Throws:
java.lang.Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soJChannel.connect(String)
will throw an exception
-
stop
public void stop()
Description copied from class:Protocol
This method is called on aJChannel.disconnect()
. Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed
-
down
public java.lang.Object down(Event evt)
Description copied from class:Protocol
An event is to be sent down the stack. A protocol may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the protocol may need to add a header to it (or do nothing at all) before sending it down the stack usingdown_prot.down()
.
-
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.
-
up
public void up(MessageBatch batch)
Description copied from class:Protocol
Sends up a multiple messages in aMessageBatch
. 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 (callingProtocol.accept(org.jgroups.Message)
), and - if true - callsProtocol.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. usingMessageBatch.getMatchingMessages(short,boolean)
), 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.
-
queue
protected void queue(Message msg)
-
startBatcher
public void startBatcher()
-
stopBatcher
protected void stopBatcher()
-
-