プロキシ

class Proxy

CronetEngine で使用できるプロキシを表します。

プロキシ経由で HTTP リクエストが送信される方法は、さまざまな要因によって異なります。たとえば、使用されているプロキシのタイプ、使用されている HTTP バージョン、リクエストが http または https URI スキームの宛先に送信されているかどうかなどです。また、プロキシ経由のトンネルが確立されるかどうかも、これらの要因によって決まります。

概要

ネストされた型

HTTP CONNECT 経由で確立されたトンネルを制御します。

onResponseReceived の呼び出しに応じて実行できるアクション。

プロキシ サーバーに送信される HTTP CONNECT リクエストを表します。
@Retention(value = RetentionPolicy.SOURCE)
@IntDef(value = )
annotation Proxy.Scheme

プロキシの定義時にサポートされるスキーム。

定数
const Int

プロキシ自体へのプレーンテキスト接続を確立します。
const Int

プロキシ自体への安全な接続を確立します。

パブリック関数
java-static Proxy
createHttpProxy(
    @Proxy.Scheme scheme: Int,
    host: String,
    port: @IntRange(from = 0, to = 65535) Int,
    executor: Executor,
    callback: Proxy.HttpConnectCallback
)

HTTP プロキシを構築します。

定数

SCHEME_HTTP

const val SCHEME_HTTP = 0: Int

プロキシ自体へのプレーンテキスト接続を確立します。

SCHEME_HTTPS

const val SCHEME_HTTPS = 1: Int

プロキシ自体への安全な接続を確立します。

パブリック関数

createHttpProxy

java-static fun createHttpProxy(
    @Proxy.Scheme scheme: Int,
    host: String,
    port: @IntRange(from = 0, to = 65535) Int,
    executor: Executor,
    callback: Proxy.HttpConnectCallback
): Proxy

HTTP プロキシを構築します。

HTTP プロキシ経由で HTTP リクエストを送信する場合、callback が呼び出されるかどうかは、宛先の URI スキームによって異なります。

  • https URI スキームの宛先の場合、CronetEngine はプロキシ経由でトンネルを確立します。トンネルは HTTP CONNECT リクエストを介して確立されます。この場合、 callback が呼び出され、トンネルの確立に使用される HTTP CONNECT リクエストを制御します。
  • http URI スキームの宛先の場合、CronetEngine は宛先の URI 全体を含む HTTP リクエストをプロキシに送信します。この場合、 callback は呼び出されません。
パラメータ
@Proxy.Scheme scheme: Int

host と port とともに、このプロキシを識別する Scheme。
host: String

scheme と port とともにこのプロキシを識別する空でないホスト。
port: @IntRange(from = 0, to = 65535) Int

scheme と host とともにこのプロキシを識別するポート。値は [0, 65535] の範囲内である必要があります。
executor: Executor

callback が呼び出されるエグゼキュータ。
callback: Proxy.HttpConnectCallback

CronetEngine がプロキシ経由でトンネルを確立するために送信する HTTP CONNECT リクエストとそのレスポンスを操作できるコールバック。