org.jgroups.protocols

Class DUPL

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.DUPL

public class DUPL
extends Protocol

Duplicates outgoing or incoming messages by copying them

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DUPL.Direction

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	copy_multicast_msgs
protected boolean	copy_unicast_msgs
protected int	incoming_copies
protected int	outgoing_copies

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
DUPL()
DUPL(boolean copy_multicast_msgs, boolean copy_unicast_msgs, int incoming_copies, int outgoing_copies)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	down(Event evt) An event is to be sent down the stack.
int	getIncomingCopies()
int	getOutgoingCopies()
boolean	isCopyMulticastMsgs()
boolean	isCopyUnicastMsgs()
void	setCopyMulticastMsgs(boolean copy_multicast_msgs)
void	setCopyUnicastMsgs(boolean copy_unicast_msgs)
void	setIncomingCopies(int incoming_copies)
void	setOutgoingCopies(int outgoing_copies)
java.lang.Object	up(Event evt) An event was received from the layer below.
void	up(MessageBatch batch) Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

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

Methods inherited from class java.lang.Object

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

Field Detail

incoming_copies

protected int incoming_copies

outgoing_copies

protected int outgoing_copies

copy_unicast_msgs

protected boolean copy_unicast_msgs

copy_multicast_msgs

protected boolean copy_multicast_msgs

Constructor Detail

DUPL

public DUPL()

DUPL

public DUPL(boolean copy_multicast_msgs,
            boolean copy_unicast_msgs,
            int incoming_copies,
            int outgoing_copies)

Method Detail

getIncomingCopies

public int getIncomingCopies()

setIncomingCopies

public void setIncomingCopies(int incoming_copies)

getOutgoingCopies

public int getOutgoingCopies()

setOutgoingCopies

public void setOutgoingCopies(int outgoing_copies)

isCopyUnicastMsgs

public boolean isCopyUnicastMsgs()

setCopyUnicastMsgs

public void setCopyUnicastMsgs(boolean copy_unicast_msgs)

isCopyMulticastMsgs

public boolean isCopyMulticastMsgs()

setCopyMulticastMsgs

public void setCopyMulticastMsgs(boolean copy_multicast_msgs)

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

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(org.jgroups.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.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.

Overrides:

up in class Protocol

Parameters:

batch - The message batch