HTTP/3
コード例: http3-netty
HTTP/3は、TCPの代わりにQUIC上で動作するHTTPプロトコルです。
Ktorは、Nettyサーバーエンジンで実験的なHTTP/3サポートを提供します。
HTTP/3サポートは実験的なKtor APIを使用しています。使用するには、ExperimentalKtorApiをオプトインしてください。
HTTP/3を有効にする
HTTP/3は常にTLSを使用するため、少なくとも1つのSSLコネクターを設定する必要があります。
HTTP/3を有効にするには、Nettyエンジンの設定で enableHttp3() 関数を呼び出します:
@OptIn(ExperimentalKtorApi::class)
fun main(args: Array<String>) {
val keyStore = KeyStore.getInstance("JKS").apply {
FileInputStream("keystore.jks").use {
load(it, "foobar".toCharArray())
}
}
embeddedServer(
Netty,
configure = {
sslConnector(
keyStore = keyStore,
keyAlias = "server",
keyStorePassword = { "foobar".toCharArray() },
privateKeyPassword = { "foobar".toCharArray() }
) {
host = "0.0.0.0"
port = 8443
}
enableHttp3()
}
){
module()
}.start(wait = true)
}各SSLコネクターに対して、KtorはUDP経由で同じホストおよびポートにHTTP/3エンドポイントをバインドします。HTTP/1.1およびHTTP/2は、引き続きそのポートでTCPを使用します。
証明書およびSSLコネクターの設定に関する詳細については、Ktor ServerにおけるSSLと証明書を参照してください。
HTTP/3を設定する
HTTP/3およびQUICの動作をカスタマイズするには、enableHttp3() 設定ブロック内の利用可能なオプションを使用します:
enableHttp3 {
quicTokenHandler = HmacQuicTokenHandler()
quicMaxIdleTimeout = 30.seconds
quicInitialMaxData = 10_000_000
quicInitialMaxStreamDataBidirectionalLocal = 1_000_000
quicInitialMaxStreamDataBidirectionalRemote = 1_000_000
quicInitialMaxStreamsBidirectional = 100
udpSocketCount = 1
udpReceiveBufferSize = 0
udpSendBufferSize = 0
}以下のオプションが利用可能です:
quicTokenHandlerデフォルトは null です。
QUICアドレス検証用の QuicTokenHandler を指定します。HMACベースの再試行トークン(retry tokens)を有効にするには、HmacQuicTokenHandler を使用します。
quicMaxIdleTimeoutデフォルトは 30.seconds です。
QUIC接続がクローズされるまでにアイドル状態でいられる期間を指定します。0 より大きい値を設定する必要があります。
quicInitialMaxDataデフォルトは 10_000_000 です。
接続の最大データ制限の初期値を指定します。0 より大きい値を設定する必要があります。
quicInitialMaxStreamDataBidirectionalLocalデフォルトは 1_000_000 です。
ローカルで開始された双方向ストリームの初期フロー制御制限を指定します。0 より大きい値を設定する必要があります。
quicInitialMaxStreamDataBidirectionalRemoteデフォルトは 1_000_000 です。
リモートで開始された双方向ストリームの初期フロー制御制限を指定します。0 より大きい値を設定する必要があります。
quicInitialMaxStreamsBidirectionalデフォルトは 100 です。
オープンできる双方向ストリームの初期数を指定します。0 より大きい値を設定する必要があります。
udpSocketCountデフォルトは 1 です。
HTTP/3エンドポイント用のUDPソケット数を指定します。1 より大きい値を設定する場合は、プラットフォームでの SO_REUSEPORT サポートが必要です。
udpReceiveBufferSizeデフォルトは 0 です。
UDP受信バッファ(SO_RCVBUF)のサイズをバイト単位で指定します。0 に設定すると、オペレーティングシステムのデフォルト値が使用されます。
udpSendBufferSizeデフォルトは 0 です。
UDP送信バッファ(SO_SNDBUF)のサイズをバイト単位で指定します。0 に設定すると、オペレーティングシステムのデフォルト値が使用されます。
これらのオプションはHTTP/3接続にのみ適用され、HTTP/1.1やHTTP/2には影響しません。
QUICサーバーコーデックを設定する
高度なNetty設定を行うには、configureQuicServerCodec オプションを使用して基盤となる QuicServerCodecBuilder をカスタマイズします:
enableHttp3 {
configureQuicServerCodec = {
// Netty QUICサーバーコーデックを設定します。
}
}このオプションは、低レベルのQUICトランスポート設定が必要な場合にのみ使用してください。
