org.soulwing.snmp

Class BlockingQueueSnmpCompletionService<V>

java.lang.Object

org.soulwing.snmp.BlockingQueueSnmpCompletionService<V>

All Implemented Interfaces:

SnmpCompletionService<V>

public class BlockingQueueSnmpCompletionService<V>
extends Object
implements SnmpCompletionService<V>

An SnmpCompletionService that is backed by a BlockingQueue.

Author:

Carl Harris

Constructor Summary

Constructors

Constructor and Description
BlockingQueueSnmpCompletionService() Creates a new completion service backed by an unbounded blocking queue.
BlockingQueueSnmpCompletionService(BlockingQueue<SnmpEvent<V>> queue) Creates a new completion service backed by the given blocking queue.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isIdle() Tests whether this completion service has a remaining event that has not yet been retrieved.
SnmpEvent<V>	poll() Gets an event representing a completed response if one is available.
SnmpEvent<V>	poll(long timeout) Gets a response event waiting as long as the specified duration for one to become available.
void	submit(SnmpOperation<V> operation) Submits an operation to the service.
SnmpEvent<V>	take() Gets a completed response waiting until one becomes available.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingQueueSnmpCompletionService

public BlockingQueueSnmpCompletionService()

Creates a new completion service backed by an unbounded blocking queue.

BlockingQueueSnmpCompletionService

public BlockingQueueSnmpCompletionService(BlockingQueue<SnmpEvent<V>> queue)

Creates a new completion service backed by the given blocking queue.

Parameters:

queue - queue that will be used to buffer received response data

Method Detail

isIdle

public boolean isIdle()

Tests whether this completion service has a remaining event that has not yet been retrieved.

Specified by:

isIdle in interface SnmpCompletionService<V>

Returns:

true if an incomplete response event remains

poll

public SnmpEvent<V> poll()

Gets an event representing a completed response if one is available.

Specified by:

poll in interface SnmpCompletionService<V>

Returns:

completed response event or null if none is available

poll

public SnmpEvent<V> poll(long timeout)
                  throws InterruptedException

Gets a response event waiting as long as the specified duration for one to become available.

Specified by:

poll in interface SnmpCompletionService<V>

Parameters:

timeout - timeout in milliseconds

Returns:

response event or null if one did not become available within the specified time interval

Throws:

InterruptedException - if the calling thread is interrupted while waiting

take

public SnmpEvent<V> take()
                  throws InterruptedException

Gets a completed response waiting until one becomes available.

Specified by:

take in interface SnmpCompletionService<V>

Returns:

completed response

Throws:

InterruptedException - if the calling thread is interrupted while waiting

submit

public void submit(SnmpOperation<V> operation)

Submits an operation to the service.

The operation is invoked asynchronously and its response is placed into the queue managed by this service. service.

Specified by:

submit in interface SnmpCompletionService<V>

Parameters:

operation - the operation to invoke