Package org.jgroups.protocols

Class TransferQueueBundler

java.lang.Object

org.jgroups.protocols.BaseBundler

org.jgroups.protocols.TransferQueueBundler

All Implemented Interfaces:

java.lang.Runnable, Bundler

Direct Known Subclasses:

AlternatingBundler

public class TransferQueueBundler
extends BaseBundler
implements java.lang.Runnable

This bundler adds all (unicast or multicast) messages to a queue until max size has been exceeded, but does send messages immediately when no other messages are available. https://issues.redhat.com/browse/JGRP-1540

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Thread	bundler_thread
protected java.util.concurrent.BlockingQueue<Message>	queue
protected java.util.List<Message>	remove_queue
protected boolean	running
protected static java.lang.String	THREAD_NAME

Fields inherited from class org.jgroups.protocols.BaseBundler

avg_fill_count, avg_remove_queue_size, avg_send_time, capacity, count, drop_when_full, FMT, FUNC, lock, log, max_size, msg_processing_policy, msg_stats, msgs, num_batches_sent, num_drops_on_full_queue, num_sends_because_full_queue, num_sends_because_no_msgs, num_single_msgs_sent, output, remove_queue_capacity, suppress_log, suppress_log_timeout, total_msgs_sent, transport, use_ringbuffer, use_single_sender_thread

Constructor Summary

Constructors

Constructor	Description
TransferQueueBundler()

Method Summary

Modifier and Type	Method	Description
protected void	addAndSendIfSizeExceeded(Message msg)
protected void	drain()	Takes all messages from the queue, adds them to the hashmap and then sends all bundled messages
int	getQueueSize()	If the bundler has a queue and it should be managed by a queuing discipline (like Random Early Detection), then return the number of elements in the queue, else -1.
void	init(TP transport)	Called after creation of the bundler
int	removeQueueCapacity()
int	removeQueueSize()
void	renameThread()
void	run()
void	send(Message msg)
int	size()	Returns the total number of messages in the hashmap
void	start()	Called after Bundler.init(TP)
void	stop()

Methods inherited from class org.jgroups.protocols.BaseBundler

addMessage, avgBatchSize, dropWhenFull, dropWhenFull, getCapacity, getMaxSize, loopback, loopback, loopbackUnlessDontLoopbackIsSet, printBuffers, removeQueueCapacity, resetStats, sendBundledMessages, sendMessageList, sendMessageListArray, sendMultiple, sendMultiple, sendSingle, sendSingleMessage, setCapacity, setMaxSize, useRingBuffer, useRingBuffer, useSingleSenderThread, useSingleSenderThread, viewChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgroups.protocols.Bundler

destroy

Field Detail

queue

protected java.util.concurrent.BlockingQueue<Message> queue

remove_queue

protected java.util.List<Message> remove_queue

bundler_thread

protected java.lang.Thread bundler_thread

running

protected volatile boolean running

THREAD_NAME

protected static final java.lang.String THREAD_NAME

See Also:

Constant Field Values

Constructor Detail

TransferQueueBundler

public TransferQueueBundler()

Method Detail

getQueueSize

public int getQueueSize()

Description copied from interface: Bundler

If the bundler has a queue and it should be managed by a queuing discipline (like Random Early Detection), then return the number of elements in the queue, else -1. In the latter case, the queue won't be managed.
This method needs to be fast as it might get called on every message to be sent.

Specified by:

getQueueSize in interface Bundler

Overrides:

getQueueSize in class BaseBundler

removeQueueSize

public int removeQueueSize()

removeQueueCapacity

public int removeQueueCapacity()

Overrides:

removeQueueCapacity in class BaseBundler

init

public void init(TP transport)

Description copied from interface: Bundler

Called after creation of the bundler

Specified by:

init in interface Bundler

Overrides:

init in class BaseBundler

Parameters:

transport - the transport, for further reference

start

public void start()

Description copied from interface: Bundler

Called after Bundler.init(TP)

Specified by:

start in interface Bundler

Overrides:

start in class BaseBundler

stop

public void stop()

Specified by:

stop in interface Bundler

Overrides:

stop in class BaseBundler

renameThread

public void renameThread()

Specified by:

renameThread in interface Bundler

size

public int size()

Description copied from class: BaseBundler

Returns the total number of messages in the hashmap

Specified by:

size in interface Bundler

Overrides:

size in class BaseBundler

send

public void send(Message msg)
          throws java.lang.Exception

Specified by:

send in interface Bundler

Overrides:

send in class BaseBundler

Throws:

java.lang.Exception

run

public void run()

Specified by:

run in interface java.lang.Runnable

addAndSendIfSizeExceeded

protected void addAndSendIfSizeExceeded(Message msg)

drain

protected void drain()

Takes all messages from the queue, adds them to the hashmap and then sends all bundled messages