ExitGames.Threading.BlockingQueue< T > Class Template Reference

This class is a Queue<T> wrapper that waits at Dequeue() until an item becomes available. More...

Public Member Functions
	BlockingQueue (int maxSize, int lockTimeout)
	Initializes a new instance of the BlockingQueue<T> class. More...
T	Dequeue ()
	Dequeues the next item. This methods waits until an item becomes available or until the default timeout has expired. More...
T	Dequeue (TimeSpan timeout)
	Dequeues the next item. This methods waits until an item becomes available or until the timeout has expired. More...
T	Dequeue (int waitTime)
	Dequeues the next item. This methods waits until an item becomes available or until the timeout has expired. More...
void	Enqueue (T item)
	Enqueues an item. The default timeout is used to detect dead locks. More...
void	Enqueue (T item, TimeSpan timeout)
	Enqueues an item. The timeout is used to detect dead locks. More...
void	Enqueue (T value, int timeOut)
	Enqueues an item. The timeout is used to detect dead locks. More...

Properties
int	MaxSize [get]
	Gets the max queue length. More...

Detailed Description

This class is a Queue<T> wrapper that waits at Dequeue() until an item becomes available.

Template Parameters

T	Type of object in queue.

Constructor & Destructor Documentation

BlockingQueue()

ExitGames.Threading.BlockingQueue< T >.BlockingQueue ( int  maxSize, int  lockTimeout  )

inline

Initializes a new instance of the BlockingQueue<T> class.

Parameters

maxSize	The max queue length.
lockTimeout	The max time in milliseconds to wait for a new item.

Member Function Documentation

Dequeue() [1/3]

T ExitGames.Threading.BlockingQueue< T >.Dequeue ( )

inline

Dequeues the next item. This methods waits until an item becomes available or until the default timeout has expired.

Returns

The next item in queue.

Exceptions

TimeoutException

No item available within given time.

Dequeue() [2/3]

T ExitGames.Threading.BlockingQueue< T >.Dequeue ( int  waitTime )

inline

Dequeues the next item. This methods waits until an item becomes available or until the timeout has expired.

Parameters

waitTime

The max wait time in milliseconds.

Returns

The next item in queue.

Exceptions

TimeoutException

No item available within given time.

Dequeue() [3/3]

T ExitGames.Threading.BlockingQueue< T >.Dequeue ( TimeSpan  timeout )

inline

Dequeues the next item. This methods waits until an item becomes available or until the timeout has expired.

Parameters

timeout

The max time to wait.

Returns

The next item in queue.

Exceptions

TimeoutException

No item available within given time.

Enqueue() [1/3]

void ExitGames.Threading.BlockingQueue< T >.Enqueue ( T  item )

inline

Enqueues an item. The default timeout is used to detect dead locks.

Parameters

item

The item.

Exceptions

TimeoutException

The item could not be enqueued within the given time.

Enqueue() [2/3]

void ExitGames.Threading.BlockingQueue< T >.Enqueue ( T  item, TimeSpan  timeout  )

inline

Enqueues an item. The timeout is used to detect dead locks.

Parameters

item	The item.
timeout	The timeout.

Exceptions

TimeoutException

The item could not be enqueued within the given time.

Enqueue() [3/3]

void ExitGames.Threading.BlockingQueue< T >.Enqueue ( T  value, int  timeOut  )

inline

Enqueues an item. The timeout is used to detect dead locks.

Parameters

value	The value.
timeOut	The time out.

Exceptions

TimeoutException

The item could not be enqueued within the given time.

Property Documentation

MaxSize

int ExitGames.Threading.BlockingQueue< T >.MaxSize

get

Gets the max queue length.