org.granite.client.messaging.channel

Class AsyncToken

java.lang.Object

java.util.TimerTask

org.granite.client.messaging.channel.AsyncToken

All Implemented Interfaces:

java.lang.Runnable, ResponseMessageFuture

public class AsyncToken
extends java.util.TimerTask
implements ResponseMessageFuture

Author:

Franck WOLFF

Constructor Summary

Constructors

Constructor and Description
AsyncToken(RequestMessage request)
AsyncToken(RequestMessage request, ResponseListener listener)
AsyncToken(RequestMessage request, ResponseListener[] listeners)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancel the current request
boolean	dispatchCancelled()
boolean	dispatchFailure(java.lang.Exception e)
boolean	dispatchFault(FaultMessage fault)
boolean	dispatchResult(ResultMessage result)
boolean	dispatchTimeout(long millis)
boolean	equals(java.lang.Object obj)
ResponseMessage	get() Wait synchronously for the response
ResponseMessage	get(long timeout) Wait synchronously for the response.
java.lang.String	getId()
RequestMessage	getRequest()
int	hashCode()
boolean	isCancelled() Is the request cancelled ?
boolean	isDisconnectRequest()
boolean	isDone() Is the request finished ?
void	run()
Event	setChannelListener(ResponseListener channelListener)
java.lang.String	toString()

Methods inherited from class java.util.TimerTask

scheduledExecutionTime

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AsyncToken

public AsyncToken(RequestMessage request)

AsyncToken

public AsyncToken(RequestMessage request,
          ResponseListener listener)

AsyncToken

public AsyncToken(RequestMessage request,
          ResponseListener[] listeners)

Method Detail

getId

public java.lang.String getId()

getRequest

public RequestMessage getRequest()

isDisconnectRequest

public boolean isDisconnectRequest()

setChannelListener

public Event setChannelListener(ResponseListener channelListener)

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class java.util.TimerTask

cancel

public boolean cancel()

Description copied from interface: ResponseMessageFuture

Cancel the current request

Specified by:

cancel in interface ResponseMessageFuture

Overrides:

cancel in class java.util.TimerTask

Returns:

true if cancelled

get

public ResponseMessage get()
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException

Description copied from interface: ResponseMessageFuture

Wait synchronously for the response

Specified by:

get in interface ResponseMessageFuture

Returns:

response

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

get

public ResponseMessage get(long timeout)
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException

Description copied from interface: ResponseMessageFuture

Wait synchronously for the response. This method throws a TimeoutException if the specified amount of time (timeout) has elapsed before the response is received. If timeout is zero, however, then the method simply waits until the response is received or the default transport timeout has elapsed.

Specified by:

get in interface ResponseMessageFuture

Parameters:

timeout - the maximum time to wait in milliseconds.

Returns:

response

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Description copied from interface: ResponseMessageFuture

Is the request cancelled ?

Specified by:

isCancelled in interface ResponseMessageFuture

Returns:

true if cancelled

isDone

public boolean isDone()

Description copied from interface: ResponseMessageFuture

Is the request finished ?

Specified by:

isDone in interface ResponseMessageFuture

Returns:

true if finished

dispatchResult

public boolean dispatchResult(ResultMessage result)

dispatchFault

public boolean dispatchFault(FaultMessage fault)

dispatchFailure

public boolean dispatchFailure(java.lang.Exception e)

dispatchTimeout

public boolean dispatchTimeout(long millis)

dispatchCancelled

public boolean dispatchCancelled()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object