public abstract class

InMemoryTransformCronetCallback

extends ImplicitFlowControlCallback
java.lang.Object
   ↳ org.chromium.net.UrlRequest.Callback
     ↳ org.chromium.net.apihelpers.ImplicitFlowControlCallback
       ↳ org.chromium.net.apihelpers.InMemoryTransformCronetCallback<T>
Known Direct Subclasses

Class Overview

An abstract Cronet callback that reads the entire body to memory and optionally deserializes the body before passing it back to the issuer of the HTTP request.

The requester can subscribe for updates about the request by adding completion mListeners on the callback. When the request reaches a terminal state, the mListeners are informed in order of addition.

Summary

Public Constructors
InMemoryTransformCronetCallback()
Public Methods
ImplicitFlowControlCallback addCompletionListener(CronetRequestCompletionListener<? super T> listener)
Adds a completion listener.
Protected Methods
final void onBodyChunkRead(UrlResponseInfo info, ByteBuffer bodyChunk)
Invoked whenever part of the response body has been read.
final void onCanceled(UrlResponseInfo info)
Invoked if request was canceled via cancel().
final void onFailed(UrlResponseInfo info, CronetException exception)
Invoked if request failed for any reason after start().
final void onResponseStarted(UrlResponseInfo info)
Invoked when the final set of headers, after all redirects, is received.
final void onSucceeded(UrlResponseInfo info)
Invoked when request is completed successfully.
abstract T transformBodyBytes(UrlResponseInfo info, byte[] bodyBytes)
Transforms (deserializes) the plain full body into a user-defined object.
[Expand]
Inherited Methods
From class org.chromium.net.apihelpers.ImplicitFlowControlCallback
From class org.chromium.net.UrlRequest.Callback
From class java.lang.Object

Public Constructors

public InMemoryTransformCronetCallback ()

Public Methods

public ImplicitFlowControlCallback addCompletionListener (CronetRequestCompletionListener<? super T> listener)

Adds a completion listener. All listeners are informed when the request reaches a terminal state, in order of addition. If a listener is added multiple times, it will only be called once according to the first time it was added.

Parameters
listener CronetRequestCompletionListener
Returns
ImplicitFlowControlCallback

Protected Methods

protected final void onBodyChunkRead (UrlResponseInfo info, ByteBuffer bodyChunk)

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. The buffer is ready for reading. Buffers are reused internally so the implementing class shouldn't store the buffer or use it anywhere else than in the implementation of this method.

Parameters
info UrlResponseInfo: Response information.
bodyChunk ByteBuffer: The buffer that contains the received data, flipped for reading.
Throws
Exception

protected final void onCanceled (UrlResponseInfo info)

Invoked if request was canceled via cancel(). Once invoked, no other UrlRequest.Callback methods will be invoked.

Parameters
info UrlResponseInfo: Response information. May be null if no response was received.

protected final void onFailed (UrlResponseInfo info, CronetException exception)

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

Parameters
info UrlResponseInfo: Response information. May be null if no response was received.
exception CronetException: information about error.

protected final void onResponseStarted (UrlResponseInfo info)

Invoked when the final set of headers, after all redirects, is received. Will only be invoked once for each request. It's guaranteed that Cronet doesn't start reading the body until this method returns.

Parameters
info UrlResponseInfo: Response information.

protected final void onSucceeded (UrlResponseInfo info)

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

Parameters
info UrlResponseInfo: Response information.

protected abstract T transformBodyBytes (UrlResponseInfo info, byte[] bodyBytes)

Transforms (deserializes) the plain full body into a user-defined object.

It is assumed that the implementing classes handle edge cases (such as empty and malformed bodies) appropriately. Cronet doesn't inspects the objects and passes them (or any exceptions) along to the issuer of the request.

Parameters
info UrlResponseInfo
bodyBytes byte
Returns
T