Package org.jgroups.protocols

Class DUPL

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.DUPL

All Implemented Interfaces:

Lifecycle

public class DUPL
extends Protocol

Duplicates outgoing or incoming messages by copying them

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	DUPL.Direction

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DUPL()
DUPL(boolean copy_multicast_msgs, boolean copy_unicast_msgs, int incoming_copies, int outgoing_copies)

Method Summary

Modifier and Type	Method	Description
private void	copy(Message msg, int num_copies, DUPL.Direction direction)
Object	down(Message msg)	A message is sent down the stack.
int	getIncomingCopies()
int	getOutgoingCopies()
boolean	isCopyMulticastMsgs()
boolean	isCopyUnicastMsgs()
DUPL	setCopyMulticastMsgs(boolean copy_multicast_msgs)
DUPL	setCopyUnicastMsgs(boolean copy_unicast_msgs)
DUPL	setIncomingCopies(int incoming_copies)
DUPL	setOutgoingCopies(int outgoing_copies)
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, destroy, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, toString, up

Methods inherited from class java.lang.Object

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

Field Details

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 Details

DUPL

public DUPL()

DUPL

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

Method Details

getIncomingCopies

public int getIncomingCopies()

setIncomingCopies

public DUPL setIncomingCopies(int incoming_copies)

getOutgoingCopies

public int getOutgoingCopies()

setOutgoingCopies

public DUPL setOutgoingCopies(int outgoing_copies)

isCopyUnicastMsgs

public boolean isCopyUnicastMsgs()

setCopyUnicastMsgs

public DUPL setCopyUnicastMsgs(boolean copy_unicast_msgs)

isCopyMulticastMsgs

public boolean isCopyMulticastMsgs()

setCopyMulticastMsgs

public DUPL setCopyMulticastMsgs(boolean copy_multicast_msgs)

down

public 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 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

copy

private void copy(Message msg,
 int num_copies,
 DUPL.Direction direction)