java.lang.Object
- org.jgroups.protocols.BaseBundler
- - org.jgroups.protocols.TransferQueueBundler

All Implemented Interfaces:

java.lang.Runnable, Bundler

Direct Known Subclasses:

AlternatingBundler, SimplifiedTransferQueueBundler
```
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.jboss.org/browse/JGRP-1540

Field Summary

Fields
Modifier and Type	Field	Description
`protected AverageMinMax`	`avg_fill_count`
`protected java.lang.Thread`	`bundler_thread`
`protected boolean`	`drop_when_full`
`protected long`	`num_drops_on_full_queue`
`protected long`	`num_sends_because_full_queue`
`protected long`	`num_sends_because_no_msgs`
`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
count, lock, log, msgs, output, transport

Constructor Summary

Constructors
Modifier	Constructor	Description
	`TransferQueueBundler()`
	`TransferQueueBundler(int capacity)`
`protected`	`TransferQueueBundler(java.util.concurrent.BlockingQueue<Message> queue)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`_addMessage(Message msg, long size)`
`protected void`	`_sendBundledMessages()`
`protected void`	`addAndSendIfSizeExceeded(Message msg)`
`protected static int`	`assertPositive(int value, java.lang.String message)`
`protected void`	`drain()`	Takes all messages from the queue, adds them to the hashmap and then sends all bundled messages
`int`	`getBufferSize()`
`boolean`	`getDropWhenFull()`
`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.
`java.util.Map<java.lang.String,java.lang.Object>`	`getStats()`	Returns stats about the bundler itself.
`java.lang.Thread`	`getThread()`
`void`	`init(TP tp)`	Called after creation of the bundler
`int`	`removeQueueSize()`
`TransferQueueBundler`	`removeQueueSize(int size)`
`void`	`resetStats()`
`void`	`run()`
`void`	`send(Message msg)`
`TransferQueueBundler`	`setDropWhenFull(boolean b)`
`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, clearMessages, sendBundledMessages, sendMessageList, sendSingleMessage, viewChange

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - queue
```
protected java.util.concurrent.BlockingQueue<Message> queue
```
  - remove_queue
```
protected java.util.List<Message> remove_queue
```
  - bundler_thread
```
protected volatile java.lang.Thread bundler_thread
```
  - drop_when_full
```
protected boolean drop_when_full
```
  - running
```
protected volatile boolean running
```
  - num_sends_because_full_queue
```
protected long num_sends_because_full_queue
```
  - num_sends_because_no_msgs
```
protected long num_sends_because_no_msgs
```
  - num_drops_on_full_queue
```
protected long num_drops_on_full_queue
```
  - avg_fill_count
```
protected final AverageMinMax avg_fill_count
```
  - THREAD_NAME
```
protected static final java.lang.String THREAD_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferQueueBundler
```
public TransferQueueBundler()
```
  - TransferQueueBundler
```
protected TransferQueueBundler(java.util.concurrent.BlockingQueue<Message> queue)
```
  - TransferQueueBundler
```
public TransferQueueBundler(int capacity)
```
- Method Detail
  - getThread
```
public java.lang.Thread getThread()
```
  - getBufferSize
```
public int getBufferSize()
```
  - removeQueueSize
```
public int removeQueueSize()
```
  - removeQueueSize
```
public TransferQueueBundler removeQueueSize(int size)
```
  - getDropWhenFull
```
public boolean getDropWhenFull()
```
  - setDropWhenFull
```
public TransferQueueBundler setDropWhenFull(boolean b)
```
  - getStats
```
public java.util.Map<java.lang.String,java.lang.Object> getStats()
```
    Description copied from interface: Bundler
    
    Returns stats about the bundler itself.
    
    Specified by:
    
    getStats in interface Bundler
    
    Returns:
    
    Stats, may be null
  - resetStats
```
public void resetStats()
```
    Specified by:
    
    resetStats in interface Bundler
  - init
```
public void init(TP tp)
```
    Description copied from interface: Bundler
    
    Called after creation of the bundler
    
    Specified by:
    
    init in interface Bundler
    
    Overrides:
    
    init in class BaseBundler
    
    Parameters:
    
    tp - 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
  - 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
  - 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
  - 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
  - _sendBundledMessages
```
protected void _sendBundledMessages()
```
  - _addMessage
```
protected void _addMessage(Message msg,
                           long size)
```
  - assertPositive
```
protected static int assertPositive(int value,
                                    java.lang.String message)
```

Class TransferQueueBundler

Field Summary

Fields inherited from class org.jgroups.protocols.BaseBundler

Constructor Summary

Method Summary

Methods inherited from class org.jgroups.protocols.BaseBundler

Methods inherited from class java.lang.Object

Field Detail

queue

remove_queue

bundler_thread

drop_when_full

running

num_sends_because_full_queue

num_sends_because_no_msgs

num_drops_on_full_queue

avg_fill_count

THREAD_NAME

Constructor Detail

TransferQueueBundler

TransferQueueBundler

TransferQueueBundler

Method Detail

getThread

getBufferSize

removeQueueSize

removeQueueSize

getDropWhenFull

setDropWhenFull

getStats

resetStats

init

start

stop

size

getQueueSize

send

run

addAndSendIfSizeExceeded

drain

_sendBundledMessages

_addMessage

assertPositive