RequestFinishedInfo

public abstract class RequestFinishedInfo


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

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

概要

ネストされた型

public abstract class RequestFinishedInfo.Listener

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

public abstract class RequestFinishedInfo.Metrics

単一のリクエストで収集された指標。

定数

static final int

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

static final int
FAILED = 1

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

static final int

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

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

パブリック メソッド

abstract Collection<Object>

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

abstract @Nullable CronetException

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

abstract int

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

abstract RequestFinishedInfo.Metrics

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

abstract @Nullable UrlResponseInfo

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

abstract String

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

定数

CANCELED

public static final int CANCELED = 2

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

失敗

public static final int FAILED = 1

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

SUCCEEDED

public static final int SUCCEEDED = 0

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

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

RequestFinishedInfo

public RequestFinishedInfo()

パブリック メソッド

getAnnotations

public abstract Collection<ObjectgetAnnotations()

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

戻り値
Collection<Object>

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

getException

public abstract @Nullable CronetException getException()

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

戻り値
@Nullable CronetException

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

getFinishedReason

public abstract int getFinishedReason()

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

戻り値
int

SUCCEEDEDFAILEDCANCELED のいずれか

getMetrics

public abstract RequestFinishedInfo.Metrics getMetrics()

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

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

戻り値
RequestFinishedInfo.Metrics

このリクエストで収集された指標。

getResponseInfo

public abstract @Nullable UrlResponseInfo getResponseInfo()

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

戻り値
@Nullable UrlResponseInfo

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

getUrl

public abstract String getUrl()

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

戻り値
String

リクエストの元の URL