CronetEngine.Builder

const val HTTP_CACHE_DISABLED = 0: Int

HTTP キャッシュを無効にする設定。一部のデータはメモリに一時的に保存されることがあります。enableHttpCache に渡されました。

const val HTTP_CACHE_DISK = 3: Int

HTTP データを含むディスク上のキャッシュを有効にする設定。この定数を enableHttpCache に渡す前に setStoragePath を呼び出す必要があります。

const val HTTP_CACHE_DISK_NO_HTTP = 2: Int

HTTP データを除外してディスク上のキャッシュを有効にする設定。この定数を enableHttpCache に渡す前に setStoragePath を呼び出す必要があります。

const val HTTP_CACHE_IN_MEMORY = 1: Int

HTTP データを含むインメモリ HTTP キャッシュを有効にする設定。enableHttpCache に渡されました。

Builder(context: Context!)

CronetEngine の作成を容易にする Builder オブジェクトを構築します。デフォルトの構成では、HTTP/2 と QUIC が有効になり、HTTP キャッシュが無効になります。

fun addPublicKeyPins(
    hostName: String!,
    pinsSha256: (Mutable)Set<ByteArray!>!,
    includeSubdomains: Boolean,
    expirationDate: Date!
): CronetEngine.Builder!

指定されたホストの公開鍵のセットをピン留めします。公開鍵のセット pinsSha256 をピン留めすると、hostName との通信では、ピン留めされたセットの公開鍵を含む証明書で認証する必要があります。アプリは、ルート証明書、中間証明書、エンド エントリ証明書のいずれかの公開鍵を固定できます。ホストがデバイスの信頼できる証明書ストアで許可されている証明書で認証を試みても、公開鍵がホストの証明書チェーンに存在しない場合、認証は失敗し、安全な通信は確立されません。

同じホスト名でこのメソッドを複数回呼び出すと、ホストに対して以前に設定されたピンがオーバーライドされます。

公開鍵のピン留めについて詳しくは、RFC 7469 をご覧ください。

fun addQuicHint(host: String!, port: Int, alternatePort: Int): CronetEngine.Builder!

host が QUIC をサポートしていることを示すヒントを追加します。セッション間の 0-RTT 接続確立を利用するには、enableHttpCache（HTTP_CACHE_DISK）が必要です。

fun build(): CronetEngine!

このビルダーの構成を使用して CronetEngine をビルドします。

fun enableBrotli(value: Boolean): CronetEngine.Builder!

Brotli 圧縮を有効にするかどうかを設定します。有効にすると、Brotli が Accept-Encoding リクエスト ヘッダーでアドバタイズされます。デフォルトは disabled です。

fun enableHttp2(value: Boolean): CronetEngine.Builder!

HTTP/2 プロトコルを有効にするかどうかを設定します。デフォルトは enabled です。

fun enableHttpCache(cacheMode: Int, maxSize: Long): CronetEngine.Builder!

HTTP データや QUIC サーバー情報などの情報のキャッシュ保存を有効または無効にします。

fun enableNetworkQualityEstimator(value: Boolean): CronetEngine.Builder!

ネットワーク品質推定ツールを有効にします。このツールは、ネットワーク スタックのさまざまなレイヤでラウンドトリップ時間（RTT）とダウンストリーム スループットの測定値を収集してレポートします。推定ツールを有効にすると、RTT とスループットのリスナーを addRttListener と addThroughputListener で追加し、removeRttListener と removeThroughputListener で削除できるようになります。エスティメータは、有効になっている場合にのみメモリと CPU を使用します。

fun enablePublicKeyPinningBypassForLocalTrustAnchors(value: Boolean): CronetEngine.Builder!

ローカル トラスト アンカーの公開鍵ピニング バイパスを有効または無効にします。ローカル信頼アンカーのバイパスを無効にすると、アプリがピン留めされたホストと通信できなくなる可能性があるため、無効にしないことを強くおすすめします。たとえば、ユーザーはデバイスのプロキシ設定を変更し、プロキシ証明書をローカルの信頼アンカーのリストに追加することで、SSL 対応のプロキシを介してすべてのトラフィックを送信したい場合があります。バイパスを無効にすると、アプリが固定されたホストにトラフィックを送信できなくなる可能性が高くなります。詳しくは、https://www.chromium.org/Home/chromium-security/security-faq の「キー ピンニングはローカル プロキシやフィルタとどのように連携しますか？」をご覧ください。

fun enableQuic(value: Boolean): CronetEngine.Builder!

QUIC プロトコルを有効にするかどうかを設定します。デフォルトは有効です。QUIC が有効になっている場合、アプリケーション名と Cronet バージョンを含む QUIC ユーザー エージェント ID がサーバーに送信されます。

fun getDefaultUserAgent(): String!

アプリケーション名とバージョン、システム ビルド バージョン、モデルと ID、Cronet バージョンを含む User-Agent 文字列を構築します。

@ConnectionMigrationOptions.Experimental
fun setConnectionMigrationOptions(
    connectionMigrationOptions: ConnectionMigrationOptions!
): CronetEngine.Builder!

接続移行の動作を構成します。詳細については、ConnectionMigrationOptions のドキュメントと ConnectionMigrationOptions.Builder の個々のメソッドをご覧ください。

enableQuic が有効になっている場合にのみ関連します。

@DnsOptions.Experimental
fun setDnsOptions(dnsOptions: DnsOptions!): CronetEngine.Builder!

ホスト名ルックアップの動作を構成します。詳細については、DnsOptions のドキュメントと DnsOptions.Builder の個々のメソッドをご覧ください。

enableQuic が有効になっている場合にのみ関連します。

fun setLibraryLoader(loader: CronetEngine.Builder.LibraryLoader!): CronetEngine.Builder!

ネイティブ ライブラリの読み込みに使用する LibraryLoader を設定します。設定されていない場合、ライブラリは loadLibrary を使用して読み込まれます。

fun setProxyOptions(proxyOptions: ProxyOptions): CronetEngine.Builder!

プロキシの動作を構成します。これは、接続の確立、UrlRequest、BidirectionalStream にさまざまな形で影響します。詳細については、Proxy のドキュメントをご覧ください。

これは、ユーザー、一部のエンタープライズ プロファイル構成、または（可能性が高い）一部のネットワーク自動構成（ウェブプロキシ自動検出プロトコルなど）によって設定されたプロキシ構成と混同しないでください。これは通常、「システム」プロキシ構成と呼ばれます。システム プロキシ構成が存在する場合、ローカル接続やインターネット接続を取得するには、その構成を尊重することが要件となることがよくあります。CronetEngine は、システム プロキシ構成を内部で処理します。

この API を介して定義されたプロキシ構成は、「アプリ」プロキシ構成と呼ばれます。アプリとシステムのプロキシ構成は別々であり、最も重要なのは、両者が異なることです。現在、アプリとシステムのプロキシ構成は相互に排他的です。ProxyOptions を指定すると、システム プロキシ構成が存在する場合、その構成がオーバーライドされます。これにより、システム プロキシ構成が存在する一部のシナリオで接続の問題が発生する可能性があります。このようなシナリオでは、ProxyOptions が最終的な null フォールバックで構成されていない限り、ユーザーはインターネットにアクセスできなくなる可能性があります。ProxyOptions のドキュメントをご覧ください。

@QuicOptions.Experimental
fun setQuicOptions(quicOptions: QuicOptions!): CronetEngine.Builder!

QUIC を使用する際の Cronet の動作を構成します。詳細については、QuicOptions のドキュメントと QuicOptions.Builder の個々のメソッドをご覧ください。

enableQuic が有効になっている場合にのみ関連します。

fun setStoragePath(value: String!): CronetEngine.Builder!

HTTP キャッシュと Cookie ストレージのディレクトリを設定します。ディレクトリが存在している必要があります。

注: 複数の CronetEngine で同時に同じストレージ ディレクトリを使用しないでください。ストレージ ディレクトリへのアクセスは、複数の CronetEngine による同時アクセスをサポートしていません。

fun setThreadPriority(priority: Int): CronetEngine.Builder!

Cronet の内部スレッドのスレッド優先度を設定します。

fun setUserAgent(userAgent: String!): CronetEngine.Builder!

すべてのリクエストの User-Agent ヘッダーをオーバーライドします。明示的に設定された User-Agent ヘッダー（addHeader を使用して設定）は、この関数を使用して設定された値をオーバーライドします。

protected val mParsedExperimentalOptions: JSONObject!

試験運用版オプションの JSON 表現。