Class/Object

play.filters.gzip

GzipFilterConfig

Related Docs: object GzipFilterConfig | package gzip

Permalink

case class GzipFilterConfig(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, shouldGzip: (RequestHeader, Result) ⇒ Boolean = (_, _) => true) extends Product with Serializable

Configuration for the gzip filter

bufferSize

The size of the buffer to use for gzipping.

chunkedThreshold

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

shouldGzip

Whether the given request/result should be gzipped. This can be used, for example, to implement black/white lists for gzipping by content type.

Source
GzipFilter.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GzipFilterConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GzipFilterConfig()

    Permalink
  2. new GzipFilterConfig(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, shouldGzip: (RequestHeader, Result) ⇒ Boolean = (_, _) => true)

    Permalink

    bufferSize

    The size of the buffer to use for gzipping.

    chunkedThreshold

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

    shouldGzip

    Whether the given request/result should be gzipped. This can be used, for example, to implement black/white lists for gzipping by content type.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val bufferSize: Int

    Permalink

    The size of the buffer to use for gzipping.

  6. val chunkedThreshold: Int

    Permalink

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

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. val shouldGzip: (RequestHeader, Result) ⇒ Boolean

    Permalink

    Whether the given request/result should be gzipped.

    Whether the given request/result should be gzipped. This can be used, for example, to implement black/white lists for gzipping by content type.

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def withBufferSize(size: Int): GzipFilterConfig

    Permalink
  21. def withChunkedThreshold(threshold: Int): GzipFilterConfig

    Permalink
  22. def withShouldGzip(shouldGzip: BiFunction[RequestHeader, Result, Boolean]): GzipFilterConfig

    Permalink
  23. def withShouldGzip(shouldGzip: (RequestHeader, Result) ⇒ Boolean): GzipFilterConfig

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped