Package com.google.gwt.http.client

Class Request

java.lang.Object

com.google.gwt.http.client.Request

public class Request
extends Object

An HTTP request that is waiting for a response. Requests can be queried for their pending status or they can be canceled.

Required Module

Modules that use this class should inherit com.google.gwt.http.HTTP.

<module>
  <!-- other inherited modules, such as com.google.gwt.user.User -->
  <inherits name="com.google.gwt.http.HTTP"/>
  <!-- additional module settings -->
</module>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Request.RequestImpl	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Request()	Only used for building a FailedRequest.
(package private)	Request(XMLHttpRequest xmlHttpRequest, int timeoutMillis, RequestCallback callback)	Constructs an instance of the Request object.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels a pending request.
(package private) void	fireOnResponseReceived(RequestCallback callback)
boolean	isPending()	Returns true if this request is waiting for a response.

Methods inherited from class java.lang.Object

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

Constructor Details

Request

protected Request()

Only used for building a FailedRequest.

Request

Request(XMLHttpRequest xmlHttpRequest,
 int timeoutMillis,
 RequestCallback callback)

Constructs an instance of the Request object.

Parameters:

xmlHttpRequest - JavaScript XmlHttpRequest object instance

timeoutMillis - number of milliseconds to wait for a response

callback - callback interface to use for notification

Throws:

IllegalArgumentException - if timeoutMillis < 0

NullPointerException - if xmlHttpRequest, or callback are null

Method Details

cancel

public void cancel()

Cancels a pending request. If the request has already been canceled or if it has timed out no action is taken.

isPending

public boolean isPending()

Returns true if this request is waiting for a response.

Returns:

true if this request is waiting for a response

fireOnResponseReceived

void fireOnResponseReceived(RequestCallback callback)