com.loopj.android.http

Class RequestHandle

java.lang.Object

com.loopj.android.http.RequestHandle

public class RequestHandle
extends java.lang.Object

A Handle to an AsyncRequest which can be used to cancel a running request.

Constructor Summary

Constructors

Constructor and Description
RequestHandle(AsyncHttpRequest request)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel this request.
java.lang.Object	getTag() Will return TAG of underlying AsyncHttpRequest if it's not already GCed
boolean	isCancelled() Returns true if this task was cancelled before it completed normally.
boolean	isFinished() Returns true if this task completed.
RequestHandle	setTag(java.lang.Object tag) Will set Object as TAG to underlying AsyncHttpRequest
boolean	shouldBeGarbageCollected()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestHandle

public RequestHandle(AsyncHttpRequest request)

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel this request. This attempt will fail if the request has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this request has not started when cancel is called, this request should never run. If the request has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this request should be interrupted in an attempt to stop the request.

After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isCancelled() will always return true if this method returned true. Subsequent calls to isDone() will return true either if the request got cancelled by this method, or if the request completed normally

Parameters:

mayInterruptIfRunning - true if the thread executing this request should be interrupted; otherwise, in-progress requests are allowed to complete

Returns:

false if the request could not be cancelled, typically because it has already completed normally; true otherwise

isFinished

public boolean isFinished()

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:

true if this task completed

isCancelled

public boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

Returns:

true if this task was cancelled before it completed

shouldBeGarbageCollected

public boolean shouldBeGarbageCollected()

getTag

public java.lang.Object getTag()

Will return TAG of underlying AsyncHttpRequest if it's not already GCed

Returns:

Object TAG, can be null

setTag

public RequestHandle setTag(java.lang.Object tag)

Will set Object as TAG to underlying AsyncHttpRequest

Parameters:

tag - Object used as TAG to underlying AsyncHttpRequest

Returns:

this RequestHandle to allow fluid syntax