okhttp3

Class RealCall

java.lang.Object

okhttp3.RealCall

All Implemented Interfaces:

java.lang.Cloneable, Call

final class RealCall
extends java.lang.Object
implements Call

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RealCall.AsyncCall

Nested classes/interfaces inherited from interface okhttp3.Call

Call.Factory

Field Summary

Fields

Modifier and Type	Field and Description
(package private) OkHttpClient	client
private EventListener	eventListener There is a cycle between the Call and EventListener that makes this awkward.
private boolean	executed
(package private) boolean	forWebSocket
(package private) Request	originalRequest The application's original request unadulterated by redirects or auth headers.
(package private) RetryAndFollowUpInterceptor	retryAndFollowUpInterceptor

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RealCall(OkHttpClient client, Request originalRequest, boolean forWebSocket)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the request, if possible.
private void	captureCallStackTrace()
RealCall	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 responseCallback) Schedules the request to be executed at some point in the future.
Response	execute() Invokes the request immediately, and blocks until the response can be processed or is in error.
(package private) Response	getResponseWithInterceptorChain()
boolean	isCanceled()
boolean	isExecuted() Returns true if this call has been either executed or enqueued.
(package private) static RealCall	newRealCall(OkHttpClient client, Request originalRequest, boolean forWebSocket)
(package private) java.lang.String	redactedUrl()
Request	request() Returns the original request that initiated this call.
(package private) StreamAllocation	streamAllocation()
(package private) java.lang.String	toLoggableString() Returns a string that describes this call.

Methods inherited from class java.lang.Object

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

Field Detail

client

final OkHttpClient client

retryAndFollowUpInterceptor

final RetryAndFollowUpInterceptor retryAndFollowUpInterceptor

eventListener

private EventListener eventListener

There is a cycle between the Call and EventListener that makes this awkward. This will be set after we create the call instance then create the event listener instance.

originalRequest

final Request originalRequest

The application's original request unadulterated by redirects or auth headers.

forWebSocket

final boolean forWebSocket

executed

private boolean executed

Constructor Detail

RealCall

private RealCall(OkHttpClient client,
                 Request originalRequest,
                 boolean forWebSocket)

Method Detail

newRealCall

static RealCall newRealCall(OkHttpClient client,
                            Request originalRequest,
                            boolean forWebSocket)

request

public Request request()

Description copied from interface: Call

Returns the original request that initiated this call.

Specified by:

request in interface Call

execute

public Response execute()
                 throws java.io.IOException

Description copied from interface: Call

Invokes the request immediately, and blocks until the response can be processed or is in error.

To avoid leaking resources callers should close the Response which in turn will close the underlying ResponseBody.

@{code

   // ensure the response (and underlying response body) is closed
   try (Response response = client.newCall(request).execute()) {
     ...
   }

 }

The caller may read the response body with the response's Response.body method. To avoid leaking resources callers must close the response body or the Response.

Note that transport-layer success (receiving a HTTP response code, headers and body) does not necessarily indicate application-layer success: response may still indicate an unhappy HTTP response code like 404 or 500.

Specified by:

execute in interface Call

Throws:

java.io.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.

captureCallStackTrace

private void captureCallStackTrace()

enqueue

public void enqueue(Callback responseCallback)

Description copied from interface: Call

Schedules the request to be executed at some point in the future.

The dispatcher defines when the request will run: usually immediately unless there are several other requests currently being executed.

This client will later call back responseCallback with either an HTTP response or a failure exception.

Specified by:

enqueue in interface Call

cancel

public void cancel()

Description copied from interface: Call

Cancels the request, if possible. Requests that are already complete cannot be canceled.

Specified by:

cancel in interface Call

isExecuted

public boolean isExecuted()

Description copied from interface: Call

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

Specified by:

isExecuted in interface Call

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface Call

clone

public RealCall clone()

Description copied from interface: Call

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

Specified by:

clone in interface Call

Overrides:

clone in class java.lang.Object

streamAllocation

StreamAllocation streamAllocation()

toLoggableString

java.lang.String toLoggableString()

Returns a string that describes this call. Doesn't include a full URL as that might contain sensitive information.

redactedUrl

java.lang.String redactedUrl()

getResponseWithInterceptorChain

Response getResponseWithInterceptorChain()
                                  throws java.io.IOException

Throws:

java.io.IOException