Grizzly NIO 5.0.2 · org.glassfish.grizzly.asyncqueue.TaskQueue

Modifier and Type	Class and Description
public static interface	TaskQueue.MutableMaxQueueSize

Field Summary

Modifier and Type	Field and Description
private volatile E	currentElement
private static final AtomicReferenceFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>, AsyncQueueRecord<R>>	currentElementUpdater
private volatile boolean	isClosed
private final TaskQueue.MutableMaxQueueSize	maxQueueSizeHolder
private final Queue<E>	queue The queue of tasks, which will be processed asynchronously
private volatile int	spaceInBytes
private static final AtomicIntegerFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>>	spaceInBytesUpdater
private volatile int	writeHandlersCounter
private static final AtomicIntegerFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>>	writeHandlersCounterUpdater
protected final Queue<WriteHandler>	writeHandlersQueue

Access	Constructor and Description
protected	TaskQueue(final TaskQueue.MutableMaxQueueSize maxQueueSizeHolder)

Method Summary

Modifier and Type	Method and Description
private void	checkWriteHandlerOnClose(final WriteHandler writeHandler)
public boolean	compareAndSetCurrentElement(final E expected, final E newValue)
public static <E extends AsyncQueueRecord<R>> TaskQueue<E>	createTaskQueue(final TaskQueue.MutableMaxQueueSize maxQueueSizeHolder)
public void	doNotify() Notifies processing the queue by write handlers.
public boolean	forgetWritePossible(final WriteHandler writeHandler)
public Queue<E>	Returns: the queue of tasks, which will be processed asynchronously getQueue() Get the queue of tasks, which will be processed asynchronously
public boolean	isEmpty()
public void	notifyWritePossible(final WriteHandler writeHandler)
public void	notifyWritePossible(final WriteHandler writeHandler, final int maxQueueSize)
public void	offer(final E new task. task) Add the new task into the task queue.
private void	offerWriteHandler(final WriteHandler writeHandler)
public void	onClose()
public void	onClose(final Throwable cause)
public E	Returns: the current processing task peek() Get the current processing task, if the current in not set, take the task from the queue.
public E	Returns: the current processing task poll() Pools the current processing task.
private WriteHandler	pollWriteHandler()
public int	Returns: the new memory (in bytes) consumed by the queue. releaseSpace(final int amount) Releases memory space in the queue.
public int	Returns: the new memory (in bytes) consumed by the queue. releaseSpaceAndNotify(final int amount) Releases memory space in the queue and notifies registered `QueueMonitor`s about the update.
public boolean	Returns: `true` if tasked was removed, or `false` otherwise. remove(final E the task to remove. task) Remove the task from queue.
private boolean	removeWriteHandler(final WriteHandler writeHandler)
public int	Returns: the new memory (in bytes) consumed by the queue. reserveSpace(final int amount) Reserves memory space in the queue.
public void	setCurrentElement(final E current element. task) Set current task element.
public int	Returns: the number of queued bytes. size() Returns the number of queued bytes.
public int	Returns: the number of queued bytes. spaceInBytes() Returns the number of queued bytes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentElement	back to summary
private volatile E currentElement

currentElementUpdater	back to summary
private static final AtomicReferenceFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>, AsyncQueueRecord<R>> currentElementUpdater

isClosed	back to summary
private volatile boolean isClosed

maxQueueSizeHolder	back to summary
private final TaskQueue.MutableMaxQueueSize maxQueueSizeHolder

queue	back to summary
private final Queue<E> queue The queue of tasks, which will be processed asynchronously

spaceInBytes	back to summary
private volatile int spaceInBytes

spaceInBytesUpdater	back to summary
private static final AtomicIntegerFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>> spaceInBytesUpdater

writeHandlersCounter	back to summary
private volatile int writeHandlersCounter

writeHandlersCounterUpdater	back to summary
private static final AtomicIntegerFieldUpdater<TaskQueue<E extends AsyncQueueRecord<R>>> writeHandlersCounterUpdater

writeHandlersQueue	back to summary
protected final Queue<WriteHandler> writeHandlersQueue

Constructor Detail

TaskQueue	back to summary
protected TaskQueue(final TaskQueue.MutableMaxQueueSize maxQueueSizeHolder)

Method Detail

checkWriteHandlerOnClose	back to summary
private void checkWriteHandlerOnClose(final WriteHandler writeHandler)

compareAndSetCurrentElement	back to summary
public boolean compareAndSetCurrentElement(final E expected, final E newValue)

createTaskQueue	back to summary
public static <E extends AsyncQueueRecord<R>> TaskQueue<E> createTaskQueue(final TaskQueue.MutableMaxQueueSize maxQueueSizeHolder)

doNotify	back to summary
public void doNotify() Notifies processing the queue by write handlers.

forgetWritePossible	back to summary
public boolean forgetWritePossible(final WriteHandler writeHandler)

getQueue	back to summary
public Queue<E> getQueue() Get the queue of tasks, which will be processed asynchronously Returns:Queue<E> the queue of tasks, which will be processed asynchronously

getQueue

back to summary

public Queue<E> getQueue()

Get the queue of tasks, which will be processed asynchronously

Returns:Queue<E>: the queue of tasks, which will be processed asynchronously

isEmpty	back to summary
public boolean isEmpty()

notifyWritePossible	back to summary
public void notifyWritePossible(final WriteHandler writeHandler)

notifyWritePossible	back to summary
public void notifyWritePossible(final WriteHandler writeHandler, final int maxQueueSize)

offer	back to summary
public void offer(final E task) Add the new task into the task queue. Parameters task:E new task.

offer

back to summary

public void offer(final E task)

Add the new task into the task queue.

Parameters

task:E: new task.

offerWriteHandler	back to summary
private void offerWriteHandler(final WriteHandler writeHandler)

onClose	back to summary
public void onClose()

onClose	back to summary
public void onClose(final Throwable cause)

peek back to summary

peek	back to summary
public E peek() Get the current processing task, if the current in not set, take the task from the queue. Note after this operation call, the current element could be removed from the queue using `setCurrentElement(org.glassfish.grizzly.asyncqueue.AsyncQueueRecord)` and passing `null` as a parameter, this is a little bit more optimal alternative to `poll()`. Returns:E the current processing task

public E peek()

Get the current processing task, if the current in not set, take the task from the queue.

Note

after this operation call, the current element could be removed from the queue using setCurrentElement(org.glassfish.grizzly.asyncqueue.AsyncQueueRecord) and passing null as a parameter, this is a little bit more optimal alternative to poll().

Returns:E: the current processing task

poll back to summary

poll	back to summary
public E poll() Pools the current processing task. Note after this operation call, any element could be put at the head of the queue using `setCurrentElement(org.glassfish.grizzly.asyncqueue.AsyncQueueRecord)` without overwriting any existing queue element. Returns:E the current processing task Annotations @SuppressWarnings:unchecked

public E poll()

Pools the current processing task.

Note

after this operation call, any element could be put at the head of the queue using setCurrentElement(org.glassfish.grizzly.asyncqueue.AsyncQueueRecord) without overwriting any existing queue element.

Returns:E

the current processing task

Annotations

@SuppressWarnings:unchecked

pollWriteHandler	back to summary
private WriteHandler pollWriteHandler()

releaseSpace	back to summary
public int releaseSpace(final int amount) Releases memory space in the queue. Returns:int the new memory (in bytes) consumed by the queue.

releaseSpace

back to summary

public int releaseSpace(final int amount)

Releases memory space in the queue.

Returns:int: the new memory (in bytes) consumed by the queue.

releaseSpaceAndNotify back to summary

releaseSpaceAndNotify	back to summary
public int releaseSpaceAndNotify(final int amount) Releases memory space in the queue and notifies registered `QueueMonitor`s about the update. Returns:int the new memory (in bytes) consumed by the queue.

public int releaseSpaceAndNotify(final int amount)

Releases memory space in the queue and notifies registered QueueMonitors about the update.

Returns:int: the new memory (in bytes) consumed by the queue.

remove back to summary

remove	back to summary
public boolean remove(final E task) Remove the task from queue. Parameters task:E the task to remove. Returns:boolean `true` if tasked was removed, or `false` otherwise.

public boolean remove(final E task)

Remove the task from queue.

Parameters

task:E: the task to remove.

Returns:boolean

true if tasked was removed, or false otherwise.

removeWriteHandler	back to summary
private boolean removeWriteHandler(final WriteHandler writeHandler)

reserveSpace	back to summary
public int reserveSpace(final int amount) Reserves memory space in the queue. Returns:int the new memory (in bytes) consumed by the queue.

reserveSpace

back to summary

public int reserveSpace(final int amount)

Reserves memory space in the queue.

Returns:int: the new memory (in bytes) consumed by the queue.

setCurrentElement	back to summary
public void setCurrentElement(final E task) Set current task element. Parameters task:E current element.

setCurrentElement

back to summary

public void setCurrentElement(final E task)

Set current task element.

Parameters

task:E: current element.

size	back to summary
public int size() Returns the number of queued bytes. Returns:int the number of queued bytes.

size

back to summary

public int size()

Returns the number of queued bytes.

Returns:int: the number of queued bytes.

spaceInBytes	back to summary
public int spaceInBytes() Returns the number of queued bytes. Returns:int the number of queued bytes.

spaceInBytes

back to summary

public int spaceInBytes()

Returns the number of queued bytes.

Returns:int: the number of queued bytes.

public final Class TaskQueue<E extends AsyncQueueRecord<R>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface TaskQueue.MutableMaxQueueSize

Method Summary

Method Detail