microsoft.aspnet.signalr.client

Class SignalRFuture<V>

java.lang.Object

microsoft.aspnet.signalr.client.SignalRFuture<V>

Type Parameters:

V - class

All Implemented Interfaces:

Future<V>

Direct Known Subclasses:

HttpConnectionFuture, UpdateableCancellableFuture

public class SignalRFuture<V>
extends Object
implements Future<V>

Represents long running SignalR operations

Constructor Summary

Constructors

Constructor and Description
SignalRFuture()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the operation
boolean	cancel(boolean mayInterruptIfRunning)
SignalRFuture<V>	done(Action<V> action) Handles the completion of the Future.
boolean	errorWasTriggered() Indicates if an error was triggered
V	get()
V	get(long timeout, TimeUnit unit)
boolean	isCancelled() Indicates if the operation is cancelled
boolean	isDone()
void	onCancelled(Runnable onCancelled) Handles the cancellation event
SignalRFuture<V>	onError(ErrorCallback errorCallback) Handles error during the execution of the Future.
void	setResult(V result) Sets a result to the future and finishes its execution
void	triggerError(Throwable error) Triggers an error for the Future

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalRFuture

public SignalRFuture()

Method Detail

onCancelled

public void onCancelled(Runnable onCancelled)

Handles the cancellation event

Parameters:

onCancelled - The handler

cancel

public void cancel()

Cancels the operation

setResult

public void setResult(V result)

Sets a result to the future and finishes its execution

Parameters:

result - The future result

isCancelled

public boolean isCancelled()

Indicates if the operation is cancelled

Specified by:

isCancelled in interface Future<V>

Returns:

True if the operation is cancelled

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

get

public V get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

get

public V get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

TimeoutException

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

done

public SignalRFuture<V> done(Action<V> action)

Handles the completion of the Future. If the future was already completed, it triggers the handler right away.

Parameters:

action - The handler

Returns:

SignalRFuture SignalRFuture

onError

public SignalRFuture<V> onError(ErrorCallback errorCallback)

Handles error during the execution of the Future. If it's the first time the method is invoked on the object and errors were already triggered, the handler will be called once per error, right away.

Parameters:

errorCallback - The handler

Returns:

SignalRFuture SignalRFuture

triggerError

public void triggerError(Throwable error)

Triggers an error for the Future

Parameters:

error - The error

errorWasTriggered

public boolean errorWasTriggered()

Indicates if an error was triggered

Returns:

True if an error was triggered