Summary: Ctors | Methods | Inherited Methods

UrlRequest.Callback

Kotlin |Java

public static abstract class UrlRequest.Callback
extends Object

java.lang.Object
↳	android.net.http.UrlRequest.Callback

Users of the HTTP stack extend this class to receive callbacks indicating the progress of a UrlRequest being processed. An instance of this class is passed in to UrlRequest.Builder's constructor when constructing the UrlRequest.

Note: All methods will be invoked on the thread of the Executor used during construction of the UrlRequest.

Summary

Public constructors
`Callback()`

Public methods
`void`	`onCanceled(UrlRequest request, UrlResponseInfo info)` Invoked if request was canceled via `UrlRequest#cancel`.
`abstract void`	`onFailed(UrlRequest request, UrlResponseInfo info, HttpException error)` Invoked if request failed for any reason after `UrlRequest#start`.
`abstract void`	`onReadCompleted(UrlRequest request, UrlResponseInfo info, ByteBuffer byteBuffer)` Invoked whenever part of the response body has been read.
`abstract void`	`onRedirectReceived(UrlRequest request, UrlResponseInfo info, String newLocationUrl)` Invoked whenever a redirect is encountered.
`abstract void`	`onResponseStarted(UrlRequest request, UrlResponseInfo info)` Invoked when the final set of headers, after all redirects, is received.
`abstract void`	`onSucceeded(UrlRequest request, UrlResponseInfo info)` Invoked when request is completed successfully.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Callback

Added in Android UpsideDownCake

public Callback ()

Public methods

onCanceled

Added in Android UpsideDownCake

public void onCanceled (UrlRequest request, 
                UrlResponseInfo info)

Invoked if request was canceled via UrlRequest#cancel. Once invoked, no other Callback methods will be invoked. Default implementation takes no action.

Parameters
`request`	`UrlRequest`: Request that was canceled.
`info`	`UrlResponseInfo`: Response information. May be `null` if no response was received.

onFailed

Added in Android UpsideDownCake

public abstract void onFailed (UrlRequest request, 
                UrlResponseInfo info, 
                HttpException error)

Invoked if request failed for any reason after UrlRequest#start. Once invoked, no other Callback methods will be invoked. error provides information about the failure.

Parameters
`request`	`UrlRequest`: Request that failed.
`info`	`UrlResponseInfo`: Response information. May be `null` if no response was received.
`error`	`HttpException`: information about error.

onReadCompleted

Added in Android UpsideDownCake

public abstract void onReadCompleted (UrlRequest request, 
                UrlResponseInfo info, 
                ByteBuffer byteBuffer)

Invoked whenever part of the response body has been read. Only part of the buffer may be populated, even if the entire response body has not yet been consumed. With the exception of onCanceled(), no other Callback method will be invoked for the request, including onSucceeded() and onFailed(), until UrlRequest.read() is called to attempt to continue reading the response body.

Parameters
`request`	`UrlRequest`: Request that received data.
`info`	`UrlResponseInfo`: Response information.
`byteBuffer`	`ByteBuffer`: The buffer that was passed in to `UrlRequest.read()`, now containing the received data. The buffer's position is updated to the end of the received data. The buffer's limit is not changed.

Throws
`Exception`	if an error occurs while processing a read completion. `onFailed(UrlRequest, UrlResponseInfo, HttpException)` will be called with the thrown exception set as the cause of the `CallbackException`.

onRedirectReceived

Added in Android UpsideDownCake

public abstract void onRedirectReceived (UrlRequest request, 
                UrlResponseInfo info, 
                String newLocationUrl)

Invoked whenever a redirect is encountered. This will only be invoked between the call to UrlRequest#start and onResponseStarted(). The body of the redirect response, if it has one, will be ignored. The redirect will not be followed until the URLRequest's UrlRequest#followRedirect method is called, either synchronously or asynchronously.

Parameters
`request`	`UrlRequest`: Request being redirected.
`info`	`UrlResponseInfo`: Response information.
`newLocationUrl`	`String`: Location where request is redirected.

Throws
`Exception`	if an error occurs while processing a redirect. `onFailed(UrlRequest, UrlResponseInfo, HttpException)` will be called with the thrown exception set as the cause of the `CallbackException`.

onResponseStarted

Added in Android UpsideDownCake

public abstract void onResponseStarted (UrlRequest request, 
                UrlResponseInfo info)

Invoked when the final set of headers, after all redirects, is received. Will only be invoked once for each request. With the exception of onCanceled(), no other Callback method will be invoked for the request, including onSucceeded() and onFailed(), until UrlRequest.read() is called to attempt to start reading the response body.

Parameters
`request`	`UrlRequest`: Request that started to get response.
`info`	`UrlResponseInfo`: Response information.

Throws
`Exception`	if an error occurs while processing response start. `onFailed(UrlRequest, UrlResponseInfo, HttpException)` will be called with the thrown exception set as the cause of the `CallbackException`.

onSucceeded

Added in Android UpsideDownCake

public abstract void onSucceeded (UrlRequest request, 
                UrlResponseInfo info)

Invoked when request is completed successfully. Once invoked, no other Callback methods will be invoked.

Parameters
`request`	`UrlRequest`: Request that succeeded.
`info`	`UrlResponseInfo`: Response information.