com.inductiveautomation.xopc.driver.api

Class BlockingRequestQueue<T extends Request<?> & java.lang.Comparable<T>>

java.lang.Object

com.inductiveautomation.xopc.driver.api.BlockingRequestQueue<T>

public class BlockingRequestQueue<T extends Request<?> & java.lang.Comparable<T>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlockingRequestQueue() Creates a BlockingRequestQueue with the default 10:1 high priority:low priority ratio.
BlockingRequestQueue(int highPerLow)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	logState(LoggerEx log)
void	put(T request)
int	size()
T	take()
com.google.common.base.Optional<T>	takeNow() A non-blocking take().

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingRequestQueue

public BlockingRequestQueue()

Creates a BlockingRequestQueue with the default 10:1 high priority:low priority ratio.

BlockingRequestQueue

public BlockingRequestQueue(int highPerLow)

Parameters:

highPerLow - The number of high priority requests to dequeue for every low priority request. (highPerLow:1)

Method Detail

put

public void put(T request)

Parameters:

request - Request to queue.

takeNow

public com.google.common.base.Optional<T> takeNow()
                                           throws java.lang.InterruptedException

A non-blocking take().

Returns:

The next request if one is available, otherwise Optional.absent().

Throws:

java.lang.InterruptedException

take

public T take()
       throws java.lang.InterruptedException

Returns:

The next Request from the queue, blocking if necessary until one is available.

Throws:

java.lang.InterruptedException

clear

public void clear()

logState

public void logState(LoggerEx log)

size

public int size()