com.vmware.vapi.bindings.client

Class AsyncCallback<T>

java.lang.Object

com.vmware.vapi.bindings.client.AsyncCallback<T>

Type Parameters:

T - type of the operation result; for void type, use java.lang.Void

Direct Known Subclasses:

AsyncCallbackFuture, AsyncCallbackSyncAdapter

public abstract class AsyncCallback<T>
extends Object

This callback is used to receive the status (progress, result or error) of an asynchronous operation invocation.

Multiple progress updates can arrive for an operation. Note that progress updates might be delivered after the result. For example consider client with an application thread pool - the thread that delivers a progress update might be scheduled before the thread that delivers the result.

Thread-safety: The implementation must be thread-safe. The methods of the callback might be invoked on different threads (for example consider client with an I/O reactor thread pool and/or an application thread pool).

Constructor Summary

Constructors

Constructor and Description
AsyncCallback()

Method Summary

Modifier and Type	Method and Description
abstract void	onError(RuntimeException error) Completes the invocation with an error.
abstract void	onProgress(Progress progress) Reports progress for the operation invocation.
abstract void	onResult(T result) Completes the invocation with a result object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCallback

public AsyncCallback()

Method Detail

onProgress

public abstract void onProgress(Progress progress)

Reports progress for the operation invocation.

Parameters:

progress - progress status of the operation invocation

onResult

public abstract void onResult(T result)

Completes the invocation with a result object.

Parameters:

result - operation result

onError

public abstract void onError(RuntimeException error)

Completes the invocation with an error. The error can be a legal/allowed vAPI error (e.g. descendant of Error) coming from the provider; UnresolvedError if the client bindings do not recognize the vAPI error from the provider; ClientException if the client-side runtime reports an error (e.g. network failure) or some other unchecked exception like IllegalArgumentException if an internal problem occurs in the client-side runtime.

Parameters:

error - operation error