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 and Description
protected class	MAKE_BATCH.Batcher

Field Summary

Fields

Modifier and Type	Field and 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, name, stack, stats, up_prot

Constructor Summary

Constructors

Constructor and Description
MAKE_BATCH()

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called on a Channel.close().
java.lang.Object	down(Event evt) An event is to be sent down the stack.
void	init() Called after instance has been created (null constructor) and before protocol is started.
MAKE_BATCH	multicasts(boolean flag)
protected void	queue(Message msg)
MAKE_BATCH	sleepTime(long time)
void	startBatcher()
protected void	stopBatcher()
MAKE_BATCH	unicasts(boolean flag)
java.lang.Object	up(Event evt) An event was received from the layer below.

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, stop, up

Methods inherited from class java.lang.Object

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

Field Detail

multicasts

protected boolean multicasts

unicasts

protected boolean unicasts

sleep_time

protected long sleep_time

reg_map_mcast

protected final java.util.Map<Address,java.util.List<Message>> reg_map_mcast

reg_map_ucast

protected final java.util.Map<Address,java.util.List<Message>> reg_map_ucast

oob_map_mcast

protected final java.util.Map<Address,java.util.List<Message>> oob_map_mcast

oob_map_ucast

protected final java.util.Map<Address,java.util.List<Message>> oob_map_ucast

timer

protected TimeScheduler timer

cluster_name

protected AsciiString cluster_name

local_addr

protected Address local_addr

batcher

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

Constructor Detail

MAKE_BATCH

public MAKE_BATCH()

Method Detail

multicasts

public MAKE_BATCH multicasts(boolean flag)

unicasts

public MAKE_BATCH unicasts(boolean flag)

sleepTime

public MAKE_BATCH sleepTime(long time)

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

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 channel constructor will throw an exception

destroy

public void destroy()

Description copied from class: Protocol

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

Overrides:

destroy in class Protocol

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. The layer 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 layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().

Overrides:

down in class Protocol

up

public java.lang.Object up(Event evt)

Description copied from class: Protocol

An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().

Overrides:

up in class Protocol

queue

protected void queue(Message msg)

startBatcher

public void startBatcher()

stopBatcher

protected void stopBatcher()