retrofit2

Interface Call<T>

Type Parameters:

T - Successful response body type.

All Superinterfaces:

java.lang.Cloneable

public interface Call<T>
extends java.lang.Cloneable

An invocation of a Retrofit method that sends a request to a webserver and returns a response. Each call yields its own HTTP request and response pair. Use clone() to make multiple calls with the same parameters to the same webserver; this may be used to implement polling or to retry a failed call.

Calls may be executed synchronously with execute(), or asynchronously with enqueue(retrofit2.Callback<T>). In either case the call can be canceled at any time with cancel(). A call that is busy writing its request or reading its response may receive a IOException; this is working as designed.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this call.
Call<T>	clone() Create a new, identical call to this one which can be enqueued or executed even if this call has already been.
void	enqueue(Callback<T> callback) Asynchronously send the request and notify callback of its response or if an error occurred talking to the server, creating the request, or processing the response.
Response<T>	execute() Synchronously send the request and return its response.
boolean	isCanceled() True if cancel() was called.
boolean	isExecuted() Returns true if this call has been either executed or enqueued.
okhttp3.Request	request() The original HTTP request.
okio.Timeout	timeout() Returns a timeout that spans the entire call: resolving DNS, connecting, writing the request body, server processing, and reading the response body.

Method Detail

execute

Response<T> execute()
             throws java.io.IOException

Synchronously send the request and return its response.

Throws:

java.io.IOException - if a problem occurred talking to the server.

java.lang.RuntimeException - (and subclasses) if an unexpected error occurs creating the request or decoding the response.

enqueue

void enqueue(Callback<T> callback)

Asynchronously send the request and notify callback of its response or if an error occurred talking to the server, creating the request, or processing the response.

isExecuted

boolean isExecuted()

Returns true if this call has been either executed or enqueued. It is an error to execute or enqueue a call more than once.

cancel

void cancel()

Cancel this call. An attempt will be made to cancel in-flight calls, and if the call has not yet been executed it never will be.

isCanceled

boolean isCanceled()

True if cancel() was called.

clone

Call<T> clone()

Create a new, identical call to this one which can be enqueued or executed even if this call has already been.

request

okhttp3.Request request()

The original HTTP request.

timeout

okio.Timeout timeout()

Returns a timeout that spans the entire call: resolving DNS, connecting, writing the request body, server processing, and reading the response body. If the call requires redirects or retries all must complete within one timeout period.