Package com.squareup.okhttp
Class Call
- java.lang.Object
-
- com.squareup.okhttp.Call
-
public class Call extends Object
A call is a request that has been prepared for execution. A call can be canceled. As this object represents a single request/response pair (stream), it cannot be executed twice.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCall(OkHttpClient client, Request originalRequest)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcancel()Cancels the request, if possible.voidenqueue(Callback responseCallback)Schedules the request to be executed at some point in the future.Responseexecute()Invokes the request immediately, and blocks until the response can be processed or is in error.booleanisCanceled()
-
-
-
Constructor Detail
-
Call
protected Call(OkHttpClient client, Request originalRequest)
-
-
Method Detail
-
execute
public Response execute() throws IOException
Invokes the request immediately, and blocks until the response can be processed or is in error.The caller may read the response body with the response's
Response.bodymethod. To facilitate connection recycling, callers should alwaysclose the response body.Note that transport-layer success (receiving a HTTP response code, headers and body) does not necessarily indicate application-layer success:
responsemay still indicate an unhappy HTTP response code like 404 or 500.- Throws:
IOException- if the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the remote server accepted the request before the failure.IllegalStateException- when the call has already been executed.
-
enqueue
public void enqueue(Callback responseCallback)
Schedules the request to be executed at some point in the future.The
dispatcherdefines when the request will run: usually immediately unless there are several other requests currently being executed.This client will later call back
responseCallbackwith either an HTTP response or a failure exception. If youcancel()a request before it completes the callback will not be invoked.- Throws:
IllegalStateException- when the call has already been executed.
-
cancel
public void cancel()
Cancels the request, if possible. Requests that are already complete cannot be canceled.
-
isCanceled
public boolean isCanceled()
-
-