WebSocket Deflate拡張

Ktorは、クライアントとサーバー向けにDeflate WebSocket拡張機能 RFC-7692 を実装しています。この拡張機能は、送信前にフレームを透過的に圧縮し、受信後に解凍できます。大量のテキストデータを送信する場合は、この拡張機能を有効にすると便利です。

インストール

この拡張機能を使用するには、まずインストールする必要があります。そのためには、extensionsブロック内でinstallメソッドを使用できます。

// For client and server
install(WebSockets) {
    extensions {
        install(WebSocketDeflateExtension) {
            /**
             * Compression level to use for [java.util.zip.Deflater].
             */
            compressionLevel = Deflater.DEFAULT_COMPRESSION

            /**
             * Prevent compressing small outgoing frames.
             */
            compressIfBiggerThan(bytes = 4 * 1024)
        }
    }
}

高度な設定パラメーター

コンテキストテイクオーバー

クライアント（およびサーバー）が圧縮ウィンドウを使用すべきかどうかを指定します。これらのパラメーターを有効にすると、単一セッションあたりに割り当てられるスペースの量を削減します。なお、java.util.zip.Deflater APIの制限のため、ウィンドウサイズは設定できません。値は15に固定されています。

clientNoContextTakeOver = false

serverNoContextTakeOver = false

これらのパラメーターはRFC-7692 Section 7.1.1に記述されています。

圧縮条件の指定

圧縮条件を明示的に指定するには、compressIfメソッドを使用できます。例えば、テキストのみを圧縮するには:

compressIf { frame -> 
    frame is Frame.Text
}

compressIfへのすべての呼び出しは、圧縮が行われる前に評価されます。

プロトコルリストの微調整

送信するプロトコルのリストは、configureProtocolsメソッドを使用して必要に応じて編集できます。

configureProtocols { protocols ->
    protocols.clear()
    protocols.add(...)
}