brotli

Type Members

1. class BrotliFilter extends EssentialFilter

   

   A brotli filter.

   A brotli filter.

   This filter may compress with brotli the responses for any requests that aren't HEAD requests and specify an accept encoding of brotli.

   It won't compresss under the following conditions:

   - The response code is 204 or 304 (these codes MUST NOT contain a body, and an empty compressed response is 20 bytes long) - The response already defines a Content-Encoding header - A custom shouldBrotli function is supplied and it returns false

   Since compressing changes the content length of the response, this filter may do some buffering - it will buffer any streamed responses that define a content length less than the configured chunked threshold. Responses that are greater in length, or that don't define a content length, will not be buffered, but will be sent as chunked responses.

   Annotations

   @Singleton()

2. trait BrotliFilterComponents extends AnyRef

   

   The brotli filter components.

3. case class BrotliFilterConfig(quality: Int = 5, chunkedThreshold: Int = 102400, shouldBrotli: (RequestHeader, Result) ⇒ Boolean = (_, _) => true) extends Product with Serializable

   

   Configuration for the brotli filter

   Configuration for the brotli filter

   quality

   The compression-speed vs compression-density tradeoffs. The higher the quality, the slower the compression. Range is 0 to 11

   chunkedThreshold

   The content length threshold, after which the filter will switch to chunking the result.

   shouldBrotli

   Whether the given request/result should be compressed with brotli. This can be used, for example, to implement black/white lists for compressing by content type.

4. class BrotliFilterConfigProvider extends Provider[BrotliFilterConfig]

   

   The brotli filter configuration provider.

   The brotli filter configuration provider.

   Annotations

   @Singleton()

5. class BrotliFilterModule extends Module

   

   The brotli filter module.