org.threadly.concurrent

Class BlockingQueueConsumer<T>

java.lang.Object

org.threadly.util.AbstractService

org.threadly.concurrent.BlockingQueueConsumer<T>

Type Parameters:

T - Type of items contained in the queue to be consumed

All Implemented Interfaces:

Service

public class BlockingQueueConsumer<T>
extends AbstractService

Producer consumer problems are very frequent within multi-threaded code. This class is designed to be a throttle for both sides of the problem. It takes in a BlockingQueue so that items are only consumed as they become available. At the same time it has a BlockingQueueConsumer.ConsumerAcceptor that will only accept items as it is ready. By accepting on the same thread as the consumer it will only try to take more items after the BlockingQueueConsumer.ConsumerAcceptor.acceptConsumedItem(Object) call returns.

Another way to look at it, this class provides the thread to handle blocking when consuming from a BlockingQueue.

Keep in mind that this class in no way attempts to solve the problem if the program is producing faster than the consumer accepts. In those conditions the queue will still continue to grow, and consume memory.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BlockingQueueConsumer.ConsumerAcceptor<T> Interface for an implementation which can accept consumed tasks.

Constructor Summary

Constructors

Constructor and Description
BlockingQueueConsumer(java.util.concurrent.ThreadFactory threadFactory, java.util.concurrent.BlockingQueue<? extends T> queue, BlockingQueueConsumer.ConsumerAcceptor<? super T> acceptor) Constructs a new consumer, with a provided queue to consume from, and an acceptor to accept items.
BlockingQueueConsumer(java.util.concurrent.ThreadFactory threadFactory, java.lang.String threadName, java.util.concurrent.BlockingQueue<? extends T> queue, BlockingQueueConsumer.ConsumerAcceptor<? super T> acceptor) Constructs a new consumer, with a provided queue to consume from, and an acceptor to accept items.

Method Summary

Methods inherited from class org.threadly.util.AbstractService

hasStopped, isRunning, start, startIfNotStarted, stop, stopIfRunning

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingQueueConsumer

public BlockingQueueConsumer(java.util.concurrent.ThreadFactory threadFactory,
                             java.util.concurrent.BlockingQueue<? extends T> queue,
                             BlockingQueueConsumer.ConsumerAcceptor<? super T> acceptor)

Constructs a new consumer, with a provided queue to consume from, and an acceptor to accept items.

Parameters:

threadFactory - ThreadFactory to construct new thread for consumer to run on

queue - queue to consume from

acceptor - acceptor to provide consumed items to

BlockingQueueConsumer

public BlockingQueueConsumer(java.util.concurrent.ThreadFactory threadFactory,
                             java.lang.String threadName,
                             java.util.concurrent.BlockingQueue<? extends T> queue,
                             BlockingQueueConsumer.ConsumerAcceptor<? super T> acceptor)

Constructs a new consumer, with a provided queue to consume from, and an acceptor to accept items.

Parameters:

threadFactory - ThreadFactory to construct new thread for consumer to run on

threadName - Name of thread consumer runs on, or null to generate a default one

queue - queue to consume from

acceptor - acceptor to provide consumed items to