UrlRequest.Callback

public abstract class UrlRequest.Callback

既知の直接サブクラス
ImplicitFlowControlCallback

リクエストのライフサイクル管理の難しさを解消し、レスポンスの読み取りを自動的に進める UrlRequest.Callback の実装。
既知の間接的なサブクラス
ByteArrayCronetCallback

InMemoryTransformCronetCallback の特殊化。解釈なしで本文のバイトをそのまま返します。
InMemoryTransformCronetCallback

本体全体をメモリに読み取り、必要に応じて本体を逆シリアル化してから HTTP リクエストの発行元に渡す抽象 Cronet コールバック。
JsonCronetCallback

レスポンスの本文を JSON として解釈する InMemoryTransformCronetCallback の特殊化。
StringCronetCallback

レスポンス本文を文字列として解釈する InMemoryTransformCronetCallback の特殊化。

Cronet のユーザーはこのクラスを拡張して、処理中の UrlRequest の進行状況を示すコールバックを受け取ります。このクラスのインスタンスは、UrlRequest を構築するときに UrlRequest.Builder のコンストラクタに渡されます。

注: すべてのメソッドは、UrlRequest の構築中に使用される java.util.concurrent.Executor のスレッドで呼び出されます。

概要

パブリック コンストラクタ

パブリック メソッド
void

cancel を介してリクエストがキャンセルされた場合に呼び出されます。
abstract void
onFailed(
    UrlRequest request,
    UrlResponseInfo info,
    CronetException error
)

start の後、なんらかの理由でリクエストが失敗した場合に呼び出されます。
abstract void
onReadCompleted(
    UrlRequest request,
    UrlResponseInfo info,
    ByteBuffer byteBuffer
)

レスポンス本文の一部が読み取られるたびに呼び出されます。
abstract void
onRedirectReceived(
    UrlRequest request,
    UrlResponseInfo info,
    String newLocationUrl
)

リダイレクトが発生するたびに呼び出されます。
abstract void

すべてのリダイレクト後のヘッダーの最終セットが受信されたときに呼び出されます。
abstract void

リクエストが正常に完了したときに呼び出されます。

パブリック コンストラクタ

コールバック

public Callback()

パブリック メソッド

onCanceled

public void onCanceled(UrlRequest request, UrlResponseInfo info)

cancel を介してリクエストがキャンセルされた場合に呼び出されます。一度呼び出されると、他の Callback メソッドは呼び出されません。デフォルトの実装では何も行いません。

パラメータ
UrlRequest request

キャンセルされたリクエスト。
UrlResponseInfo info

レスポンス情報。レスポンスが受信されなかった場合は null になることがあります。

onFailed

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

start の後、なんらかの理由でリクエストが失敗した場合に呼び出されます。一度呼び出されると、他の Callback メソッドは呼び出されません。error には、障害に関する情報が格納されます。

パラメータ
UrlRequest request

失敗したリクエスト。
UrlResponseInfo info

レスポンス情報。レスポンスが受信されなかった場合は null になることがあります。
CronetException error

エラーに関する情報。

onReadCompleted

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

レスポンス本文の一部が読み取られるたびに呼び出されます。レスポンス本文全体がまだ消費されていない場合でも、バッファの一部のみが入力されることがあります。onCanceled() を除き、UrlRequest.read() が呼び出されてレスポンス本文の読み取りを続行しようとするまで、リクエストに対して他の Callback メソッド（onSucceeded() や onFailed() など）は呼び出されません。

パラメータ
UrlRequest request

データを受信したリクエスト。
UrlResponseInfo info

レスポンス情報。
ByteBuffer byteBuffer

UrlRequest.read() に渡されたバッファ。受信したデータが含まれています。バッファの位置が、受信したデータの末尾に更新されます。バッファの上限は変更されません。
例外
java.lang.Exception

読み取り完了の処理中にエラーが発生した場合。onFailed は、スローされた例外が CallbackException の原因として設定された状態で呼び出されます。

onRedirectReceived

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

リダイレクトが発生するたびに呼び出されます。これは、start と onResponseStarted() の呼び出しの間にのみ呼び出されます。リダイレクト レスポンスの本文（存在する場合）は無視されます。リダイレクトは、URLRequest の followRedirect メソッドが同期または非同期で呼び出されるまで実行されません。

パラメータ
UrlRequest request

リクエストがリダイレクトされている。
UrlResponseInfo info

レスポンス情報。
String newLocationUrl

リクエストがリダイレクトされるロケーション。
例外
java.lang.Exception

リダイレクトの処理中にエラーが発生した場合。onFailed は、スローされた例外が CallbackException の原因として設定された状態で呼び出されます。

onResponseStarted

public abstract void onResponseStarted(UrlRequest request, UrlResponseInfo info)

すべてのリダイレクト後のヘッダーの最終セットが受信されたときに呼び出されます。リクエストごとに 1 回のみ呼び出されます。onCanceled() を除き、UrlRequest.read() が呼び出されてレスポンス本文の読み取りを開始しようとするまで、onSucceeded() や onFailed() など、他の Callback メソッドはリクエストに対して呼び出されません。

パラメータ
UrlRequest request

レスポンスの取得を開始したリクエスト。
UrlResponseInfo info

レスポンス情報。
例外
java.lang.Exception

レスポンスの開始の処理中にエラーが発生した場合。onFailed は、スローされた例外が CallbackException の原因として設定された状態で呼び出されます。

onSucceeded

public abstract void onSucceeded(UrlRequest request, UrlResponseInfo info)

リクエストが正常に完了したときに呼び出されます。一度呼び出されると、他の Callback メソッドは呼び出されません。

パラメータ
UrlRequest request

成功したリクエスト。
UrlResponseInfo info

レスポンス情報。