Package org.jgroups.protocols

Class UNBATCH

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.UNBATCH

All Implemented Interfaces:

Lifecycle

public class UNBATCH
extends Protocol

Intercepts Protocol.up(MessageBatch) and passes up each message of a message batch as a single message. Mainly to be used in unit tests (https://issues.redhat.com/browse/JGRP-2702).

Since:

5.2.18

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enabled

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

Method Summary

Modifier and Type	Method	Description
UNBATCH	enable(boolean b)
boolean	enabled()
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, 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, up

Methods inherited from class java.lang.Object

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

Field Details

enabled

protected boolean enabled

Constructor Details

UNBATCH

public UNBATCH()

Method Details

enabled

public boolean enabled()

enable

public UNBATCH enable(boolean b)

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