Class MaxOneThreadPerSender

java.lang.Object

org.jgroups.util.SubmitToThreadPool

org.jgroups.util.MaxOneThreadPerSender

All Implemented Interfaces:

Lifecycle, MessageProcessingPolicy

Direct Known Subclasses:

UnbatchOOBBatches

public class MaxOneThreadPerSender
extends SubmitToThreadPool

MessageProcessingPolicy which processes regular messages and message batches by assigning a max of 1 thread per message from the same sender. So if we have senders A, B, C and D, we'll have no more than 4 threads handling regular unicasts and 4 threads handling regular multicasts.

See JGRP-2143 for details.
When using virtual threads, we probably don't need this anymore, and can use a virtual thread to send messages / message batches directly up to UNICAST or NAKACK.

Since:

4.0

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MaxOneThreadPerSender.Entry
protected class	MaxOneThreadPerSender.MessageTable

Nested classes/interfaces inherited from class SubmitToThreadPool

SubmitToThreadPool.BatchHandler, SubmitToThreadPool.SingleMessageHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected int	batch_capacity
protected final MaxOneThreadPerSender.MessageTable	mcasts
protected int	queue_capacity
protected final MaxOneThreadPerSender.MessageTable	ucasts

Fields inherited from class SubmitToThreadPool

log, tp

Constructor Summary

Constructors

Constructor	Description
MaxOneThreadPerSender()

Method Summary

Modifier and Type	Method	Description
int	batchCapacity()
MaxOneThreadPerSender	batchCapacity(int c)
void	destroy()	Called before the transport is stopped
String	dump()
boolean	loopback(Message msg, boolean oob)	Process a message that was not received from the transport but from above (e.g.
boolean	loopback(MessageBatch batch, boolean oob)
boolean	process(Message msg, boolean oob)	Process a message received from the transport
boolean	process(MessageBatch batch, boolean oob)	Process a batch received from the transport
int	queueCapacity()
MaxOneThreadPerSender	queueCapacity(int c)
void	reset()	To reset stats
void	viewChange(List<Address> members)

Methods inherited from class SubmitToThreadPool

getTransport, init, removeAndDispatchNonBundledMessages

Methods inherited from class Object

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

Methods inherited from interface Lifecycle

init, start, stop

Field Details

mcasts

protected final MaxOneThreadPerSender.MessageTable mcasts

ucasts

protected final MaxOneThreadPerSender.MessageTable ucasts

batch_capacity

protected int batch_capacity

queue_capacity

protected int queue_capacity

Constructor Details

MaxOneThreadPerSender

public MaxOneThreadPerSender()

Method Details

batchCapacity

public int batchCapacity()

batchCapacity

public MaxOneThreadPerSender batchCapacity(int c)

queueCapacity

public int queueCapacity()

queueCapacity

public MaxOneThreadPerSender queueCapacity(int c)

dump

public String dump()

reset

public void reset()

Description copied from interface: MessageProcessingPolicy

To reset stats

destroy

public void destroy()

Description copied from interface: MessageProcessingPolicy

Called before the transport is stopped

loopback

public boolean loopback(Message msg,
 boolean oob)

Description copied from interface: MessageProcessingPolicy

Process a message that was not received from the transport but from above (e.g. the channel or a protocol), and needs to be looped back up because (1) the destination address is null (every multicast message is looped back) or (2) the destination address is the sender's address (unicast message to self).
A message that is looped back can bypass cluster name matching.

Specified by:

loopback in interface MessageProcessingPolicy

Overrides:

loopback in class SubmitToThreadPool

Parameters:

msg - the message to be looped back up the stack.

oob - true if the message is an OOB message

Returns:

loopback

public boolean loopback(MessageBatch batch,
 boolean oob)

Specified by:

loopback in interface MessageProcessingPolicy

Overrides:

loopback in class SubmitToThreadPool

process

public boolean process(Message msg,
 boolean oob)

Description copied from interface: MessageProcessingPolicy

Process a message received from the transport

Specified by:

process in interface MessageProcessingPolicy

Overrides:

process in class SubmitToThreadPool

Parameters:

msg - the message

oob - true if the message is an OOB message

Returns:

process

public boolean process(MessageBatch batch,
 boolean oob)

Description copied from interface: MessageProcessingPolicy

Process a batch received from the transport

Specified by:

process in interface MessageProcessingPolicy

Overrides:

process in class SubmitToThreadPool

Parameters:

batch - the batch

oob - true if the batch contains only OOB messages

Returns:

viewChange

public void viewChange(List<Address> members)