Package com.glitchybyte.glib.concurrent.workqueue

Class GAsyncWorkQueue<T>

java.lang.Object

com.glitchybyte.glib.concurrent.workqueue.GAsyncWorkQueue<T>

Type Parameters:

T - Type of work item.

public final class GAsyncWorkQueue<T>
extends Object

A queue of work with the following characteristics:

• Able to queue work items from multiple threads with minimal lock contention.
• Work is serviced separately from the queue, allowing work to be performed without blocking the queue.

Constructor Summary

Constructors

Constructor	Description
GAsyncWorkQueue()	Creates an asynchronous work queue.

Method Summary

Modifier and Type	Method	Description
void	addWork(T item)	Adds a work item to the queue.
void	awaitWork()	Awaits for work to be queued.
void	doWork(Consumer<T> itemConsumer)	Performs work on every item queued.

Methods inherited from class java.lang.Object

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

Constructor Details

GAsyncWorkQueue

public GAsyncWorkQueue()

Creates an asynchronous work queue.

Method Details

addWork

public void addWork(T item)

Adds a work item to the queue.

Parameters:

item - Work item.

awaitWork

public void awaitWork()
               throws InterruptedException

Awaits for work to be queued.

awaitWork and doWork must be called on the same thread.

Throws:

InterruptedException - If the thread is interrupted while awaiting.

doWork

public void doWork(Consumer<T> itemConsumer)

Performs work on every item queued.

awaitWork and doWork must be called on the same thread.

Parameters:

itemConsumer - Consumer that performs work on items.