Class/Object

com.twitter.finagle.http

Http

Related Docs: object Http | package http

Permalink

case class Http(_compressionLevel: Int = 1, _maxRequestSize: StorageUnit = 5.megabytes, _maxResponseSize: StorageUnit = 5.megabytes, _decompressionEnabled: Boolean = true, _channelBufferUsageTracker: Option[ChannelBufferUsageTracker] = None, _annotateCipherHeader: Option[String] = None, _enableTracing: Boolean = false, _maxInitialLineLength: StorageUnit = 4096.bytes, _maxHeaderSize: StorageUnit = 8192.bytes, _streaming: Boolean = false, _statsReceiver: StatsReceiver = NullStatsReceiver) extends CodecFactory[Request, Response] with Product with Serializable

_compressionLevel

The compression level to use. If passed the default value (-1) then use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use HttpContentCompressor for all content-types with specified compression level.

_maxRequestSize

The maximum size of the inbound request an HTTP server constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

_maxResponseSize

The maximum size of the inbound response an HTTP client constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

_streaming

Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies. When this flag is set to true, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream. If false, the entire message content is buffered into a com.twitter.io.Buf.

Linear Supertypes
Serializable, Serializable, Product, Equals, CodecFactory[Request, Response], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Http
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CodecFactory
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Http(_compressionLevel: Int, _maxRequestSize: StorageUnit, _maxResponseSize: StorageUnit, _decompressionEnabled: Boolean, _channelBufferUsageTracker: Option[ChannelBufferUsageTracker], _annotateCipherHeader: Option[String], _enableTracing: Boolean, _maxInitialLineLength: StorageUnit, _maxHeaderSize: StorageUnit, _streaming: Boolean)

    Permalink
  2. new Http(_compressionLevel: Int = 1, _maxRequestSize: StorageUnit = 5.megabytes, _maxResponseSize: StorageUnit = 5.megabytes, _decompressionEnabled: Boolean = true, _channelBufferUsageTracker: Option[ChannelBufferUsageTracker] = None, _annotateCipherHeader: Option[String] = None, _enableTracing: Boolean = false, _maxInitialLineLength: StorageUnit = 4096.bytes, _maxHeaderSize: StorageUnit = 8192.bytes, _streaming: Boolean = false, _statsReceiver: StatsReceiver = NullStatsReceiver)

    Permalink

    _compressionLevel

    The compression level to use. If passed the default value (-1) then use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use HttpContentCompressor for all content-types with specified compression level.

    _maxRequestSize

    The maximum size of the inbound request an HTTP server constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

    _maxResponseSize

    The maximum size of the inbound response an HTTP client constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

    _streaming

    Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies. When this flag is set to true, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream. If false, the entire message content is buffered into a com.twitter.io.Buf.

Type Members

  1. type Client = (ClientCodecConfig) ⇒ Codec[Request, Response]

    Permalink
    Definition Classes
    CodecFactory
  2. type Server = (ServerCodecConfig) ⇒ Codec[Request, Response]

    Permalink
    Definition Classes
    CodecFactory

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. val _annotateCipherHeader: Option[String]

    Permalink
  5. val _channelBufferUsageTracker: Option[ChannelBufferUsageTracker]

    Permalink
  6. val _compressionLevel: Int

    Permalink

    The compression level to use.

    The compression level to use. If passed the default value (-1) then use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use HttpContentCompressor for all content-types with specified compression level.

  7. val _decompressionEnabled: Boolean

    Permalink
  8. val _enableTracing: Boolean

    Permalink
  9. val _maxHeaderSize: StorageUnit

    Permalink
  10. val _maxInitialLineLength: StorageUnit

    Permalink
  11. val _maxRequestSize: StorageUnit

    Permalink

    The maximum size of the inbound request an HTTP server constructed with this codec can receive (default is 5 megabytes).

    The maximum size of the inbound request an HTTP server constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

  12. val _maxResponseSize: StorageUnit

    Permalink

    The maximum size of the inbound response an HTTP client constructed with this codec can receive (default is 5 megabytes).

    The maximum size of the inbound response an HTTP client constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

  13. val _statsReceiver: StatsReceiver

    Permalink
  14. val _streaming: Boolean

    Permalink

    Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.

    Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies. When this flag is set to true, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream. If false, the entire message content is buffered into a com.twitter.io.Buf.

  15. def annotateCipherHeader(headerName: String): Http

    Permalink
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. def client: (ClientCodecConfig) ⇒ Codec[Request, Response] { def newClientDispatcher(transport: com.twitter.finagle.transport.Transport[Any,Any],params: com.twitter.finagle.Stack.Params): com.twitter.finagle.http.codec.HttpClientDispatcher }

    Permalink
    Definition Classes
    Http → CodecFactory
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def compressionLevel(level: Int): Http

    Permalink
  20. def decompressionEnabled(yesno: Boolean): Http

    Permalink
  21. def enableTracing(enable: Boolean): Http

    Permalink
  22. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  26. def maxHeaderSize(size: StorageUnit): Http

    Permalink
  27. def maxInitialLineLength(length: StorageUnit): Http

    Permalink
  28. def maxRequestSize(bufferSize: StorageUnit): Http

    Permalink
  29. def maxResponseSize(bufferSize: StorageUnit): Http

    Permalink
  30. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  33. val protocolLibraryName: String

    Permalink
    Definition Classes
    Http → CodecFactory
  34. def server: (ServerCodecConfig) ⇒ Codec[Request, Response]

    Permalink
    Definition Classes
    Http → CodecFactory
  35. def streaming(enable: Boolean): Http

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def channelBufferUsageTracker(usageTracker: ChannelBufferUsageTracker): Http

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2016-05-10) Use maxRequestSize to enforce buffer footprint limits

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CodecFactory[Request, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped