org.soulwing.snmp

Interface SnmpCompletionService<V>

All Known Implementing Classes:

BlockingQueueSnmpCompletionService

public interface SnmpCompletionService<V>

A service that awaits the completion of SnmpOperation instances.

Author:

Carl Harris

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.

Method Detail

isIdle

boolean isIdle()

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

Returns:

true if an incomplete response event remains

poll

SnmpEvent<V> poll()

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

Returns:

completed response event or null if none is available

poll

SnmpEvent<V> poll(long timeout)
                  throws InterruptedException

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

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

SnmpEvent<V> take()
                  throws InterruptedException

Gets a completed response waiting until one becomes available.

Returns:

completed response

Throws:

InterruptedException - if the calling thread is interrupted while waiting

submit

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.

Parameters:

operation - the operation to invoke