Package org.jgroups.protocols

Class CLEAR_FLAGS

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.CLEAR_FLAGS

All Implemented Interfaces:

Lifecycle

public class CLEAR_FLAGS
extends Protocol

Protocol which clears a set of flags in the down or up direction for all messages

Since:

4.0.4

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<Message.Flag>	down_flags
protected final Set<Message.Flag>	up_flags

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
CLEAR_FLAGS()

Method Summary

Modifier and Type	Method	Description
CLEAR_FLAGS	addFlag(boolean down, String flag)
CLEAR_FLAGS	addFlag(boolean down, Message.Flag flag)
Object	down(Message msg)	A message is sent down the stack.
String	downFlags()
String	flags()
CLEAR_FLAGS	removeAllFlags()
CLEAR_FLAGS	removeFlag(boolean down, String flag)
CLEAR_FLAGS	removeFlag(boolean down, Message.Flag flag)
Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.
String	upFlags()

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

down_flags

protected final Set<Message.Flag> down_flags

up_flags

protected final Set<Message.Flag> up_flags

Constructor Details

CLEAR_FLAGS

public CLEAR_FLAGS()

Method Details

flags

public String flags()

addFlag

public CLEAR_FLAGS addFlag(boolean down,
 String flag)

addFlag

public CLEAR_FLAGS addFlag(boolean down,
 Message.Flag flag)

removeFlag

public CLEAR_FLAGS removeFlag(boolean down,
 String flag)

removeFlag

public CLEAR_FLAGS removeFlag(boolean down,
 Message.Flag flag)

removeAllFlags

public CLEAR_FLAGS removeAllFlags()

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

downFlags

public String downFlags()

upFlags

public String upFlags()