Package org.jgroups.protocols

Class UNBATCH_OOB

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.UNBATCH_OOB

All Implemented Interfaces:

Lifecycle

public class UNBATCH_OOB
extends Protocol

Unbatches OOB batches when enabled and virtual threads are available.
https://issues.redhat.com/browse/JGRP-2888

Since:

5.5.0

Author:

Bela Ban

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enabled
protected int	min_size
protected java.util.concurrent.atomic.LongAdder	num_oob_batches
protected java.util.concurrent.atomic.LongAdder	num_unbatched_msgs
protected ThreadPool	thread_pool

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

Method Summary

Modifier and Type	Method	Description
double	avgUnbatchedMessagesPerBatch()
UNBATCH_OOB	enable(boolean enable)
boolean	enabled()
int	minSize()
UNBATCH_OOB	minSize(int min_size)
protected void	passUp(Message msg)
void	resetStats()
void	start()	This method is called on a JChannel.connect(String); starts work.
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, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, stop, toString, up, up

Methods inherited from class java.lang.Object

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

Field Detail

enabled

protected boolean enabled

min_size

protected int min_size

num_unbatched_msgs

protected final java.util.concurrent.atomic.LongAdder num_unbatched_msgs

num_oob_batches

protected final java.util.concurrent.atomic.LongAdder num_oob_batches

thread_pool

protected ThreadPool thread_pool

Constructor Detail

UNBATCH_OOB

public UNBATCH_OOB()

Method Detail

enabled

public boolean enabled()

enable

public UNBATCH_OOB enable(boolean enable)

minSize

public int minSize()

minSize

public UNBATCH_OOB minSize(int min_size)

avgUnbatchedMessagesPerBatch

public double avgUnbatchedMessagesPerBatch()

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.

Specified by:

start in interface Lifecycle

Overrides:

start in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) will throw an exception

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

passUp

protected void passUp(Message msg)