RequestFinishedInfo

abstract class RequestFinishedInfo


完了したリクエストに関する情報。RequestFinishedInfo.Listener に渡されます。

データを元のリクエストに関連付けるには、リクエストの作成時に addRequestAnnotation を使用して一意の識別子を追加し、RequestFinishedInfo を受信したときに getAnnotations を呼び出して識別子を取得します。

概要

ネストされたタイプ

指標を収集するために、完了したリクエストをリッスンします。

単一のリクエストに対して収集された指標。

定数

const Int

リクエストがキャンセルされたことを示す理由の値。

const Int
FAILED = 1

リクエストが失敗したか、エラーを返したことを示す理由の値。

const Int

リクエストが成功したことを示す理由の値。

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

パブリック関数

abstract (Mutable)Collection<Any!>!

addRequestAnnotation を使用してリクエストを開始するときに呼び出し元が指定したオブジェクトを返します。

abstract CronetException?

リクエストが失敗した場合は、onFailed に提供されたものと同じ CronetException を返します。

abstract Int

リクエストが完了した理由を返します。

abstract RequestFinishedInfo.Metrics!

このリクエストに対して収集された指標を返します。

abstract UrlResponseInfo?

レスポンスが開始されている場合は、リクエストの UrlResponseInfo を返します。

abstract String!

リクエストの元の URL を返します。

定数

CANCELED

const val CANCELED = 2: Int

リクエストがキャンセルされたことを示す理由の値。getFinishedReason から返されます。

FAILED

const val FAILED = 1: Int

リクエストが失敗したか、エラーを返したことを示す理由の値。getFinishedReason から返されます。

SUCCEEDED

const val SUCCEEDED = 0: Int

リクエストが成功したことを示す理由の値。getFinishedReason から返されます。

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

RequestFinishedInfo

RequestFinishedInfo()

パブリック関数

getAnnotations

abstract fun getAnnotations(): (Mutable)Collection<Any!>!

addRequestAnnotation を使用してリクエストを開始するときに呼び出し元が指定したオブジェクトを返します。アノテーションを使用すると、RequestFinishedInfo を元のリクエストまたはリクエストのタイプに関連付けることができます。

戻り値
(Mutable)Collection<Any!>!

リクエストの作成時に指定されたアノテーション

getException

abstract fun getException(): CronetException?

リクエストが失敗した場合は、onFailed に提供されたものと同じ CronetException を返します。

戻り値
CronetException?

リクエストが失敗した場合のリクエストの CronetException

getFinishedReason

abstract fun getFinishedReason(): Int

リクエストが完了した理由を返します。

戻り値
Int

SUCCEEDEDFAILEDCANCELED のいずれか

getMetrics

abstract fun getMetrics(): RequestFinishedInfo.Metrics!

このリクエストに対して収集された指標を返します。

報告される時間とバイト数は、すべてのリダイレクトを考慮しています。つまり、TTFB は元のリクエストの開始から最終的なレスポンス ヘッダーまで、TTLB は元のリクエストの開始から最終的なレスポンスの終了まで、受信バイト数はすべてのリダイレクトと最終的なレスポンスの合計です。これらの累積指標の定義は議論の余地がありますが、ユーザー向けのレイテンシ分析に適しているため選択されています。

戻り値
RequestFinishedInfo.Metrics!

このリクエストに対して収集された指標。

getResponseInfo

abstract fun getResponseInfo(): UrlResponseInfo?

レスポンスが開始されている場合は、リクエストの UrlResponseInfo を返します。

戻り値
UrlResponseInfo?

レスポンスが開始されている場合は、リクエストの UrlResponseInfo

getUrl

abstract fun getUrl(): String!

リクエストの元の URL を返します。

戻り値
String!

リクエストの元の URL