org.apache.qpid.jms.provider

Class ProviderFuture

java.lang.Object

org.apache.qpid.jms.provider.ProviderFuture

All Implemented Interfaces:

AsyncResult

public class ProviderFuture
extends Object
implements AsyncResult

Asynchronous Provider Future class.

Constructor Summary

Constructors

Constructor and Description
ProviderFuture()
ProviderFuture(ProviderSynchronization synchronization)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isComplete() Returns true if the AsyncResult has completed.
void	onFailure(Throwable result) If the operation fails this method is invoked with the Exception that caused the failure.
void	onSuccess() If the operation succeeds the resulting value produced is set to null and the waiting parties are signaled.
void	sync() Waits for a response to some Provider requested operation.
void	sync(long amount, TimeUnit unit) Timed wait for a response to a Provider operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderFuture

public ProviderFuture()

ProviderFuture

public ProviderFuture(ProviderSynchronization synchronization)

Method Detail

isComplete

public boolean isComplete()

Description copied from interface: AsyncResult

Returns true if the AsyncResult has completed. The task is considered complete regardless if it succeeded or failed.

Specified by:

isComplete in interface AsyncResult

Returns:

returns true if the asynchronous operation has completed.

onFailure

public void onFailure(Throwable result)

Description copied from interface: AsyncResult

If the operation fails this method is invoked with the Exception that caused the failure.

Specified by:

onFailure in interface AsyncResult

Parameters:

result - The error that resulted in this asynchronous operation failing.

onSuccess

public void onSuccess()

Description copied from interface: AsyncResult

If the operation succeeds the resulting value produced is set to null and the waiting parties are signaled.

Specified by:

onSuccess in interface AsyncResult

sync

public void sync(long amount,
        TimeUnit unit)
          throws IOException

Timed wait for a response to a Provider operation.

Parameters:

amount - The amount of time to wait before abandoning the wait.

unit - The unit to use for this wait period.

Throws:

IOException - if an error occurs while waiting for the response.

sync

public void sync()
          throws IOException

Waits for a response to some Provider requested operation.

Throws:

IOException - if an error occurs while waiting for the response.