Packages

final case class Config(sslConfig: Option[SSLConfig], address: InetSocketAddress, acceptContinue: Boolean, keepAlive: Boolean, requestDecompression: Decompression, responseCompression: Option[ResponseCompressionConfig], requestStreaming: RequestStreaming, maxInitialLineLength: Int, maxHeaderSize: Int, logWarningOnFatalError: Boolean, gracefulShutdownTimeout: zio.Duration, webSocketConfig: WebSocketConfig, idleTimeout: Option[zio.Duration], avoidContextSwitching: Boolean, soBacklog: Int, tcpNoDelay: Boolean) extends Product with Serializable

Self Type
Config
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Config(sslConfig: Option[SSLConfig], address: InetSocketAddress, acceptContinue: Boolean, keepAlive: Boolean, requestDecompression: Decompression, responseCompression: Option[ResponseCompressionConfig], requestStreaming: RequestStreaming, maxInitialLineLength: Int, maxHeaderSize: Int, logWarningOnFatalError: Boolean, gracefulShutdownTimeout: zio.Duration, webSocketConfig: WebSocketConfig, idleTimeout: Option[zio.Duration], avoidContextSwitching: Boolean, soBacklog: Int, tcpNoDelay: Boolean)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def acceptContinue(enable: Boolean): Config

    Configure the server to use HttpServerExpectContinueHandler to send a 100 HttpResponse if necessary.

  5. val acceptContinue: Boolean
  6. val address: InetSocketAddress
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def avoidContextSwitching(value: Boolean): Config

    Attempts to avoid context switching between thread pools by executing requests within the server's IO thread-pool (e.g., Netty's EventLoop) until the first async/blocking boundary.

    Attempts to avoid context switching between thread pools by executing requests within the server's IO thread-pool (e.g., Netty's EventLoop) until the first async/blocking boundary.

    Enabling this setting can improve performance for short-lived CPU-bound tasks, but can also lead to degraded performance if the request handler performs CPU-heavy work prior to the first async boundary.

    WARNING: Do not use this mode if the ZIO executor is configured to use virtual threads!

    See also

    For more info on caveats of this mode, see <a href="https://github.com/zio/zio-http/pull/2782">related issue

  9. val avoidContextSwitching: Boolean
  10. def binding(inetSocketAddress: InetSocketAddress): Config

    Configure the server to listen on the provided InetSocketAddress.

  11. def binding(address: InetAddress, port: Int): Config

    Configure the server to listen on the provided InetAddress and port.

  12. def binding(hostname: String, port: Int): Config

    Configure the server to listen on the provided hostname and port.

  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def disableRequestStreaming(maxContentLength: Int): Config

    Disables streaming of request bodies.

    Disables streaming of request bodies. Payloads larger than maxContentLength will be rejected

  15. def enableRequestStreaming: Config

    Enables streaming request bodies

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def gracefulShutdownTimeout(duration: zio.Duration): Config
  19. val gracefulShutdownTimeout: zio.Duration
  20. def hybridRequestStreaming(maxAggregatedLength: Int): Config

    Enables hybrid request streaming

  21. def idleTimeout(duration: zio.Duration): Config
  22. val idleTimeout: Option[zio.Duration]
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def keepAlive(enable: Boolean): Config

    Configure the server to use netty's HttpServerKeepAliveHandler to close persistent connections when enable is true (@see <a href="https://netty.io/4.1/api/io/netty/handler/codec/http/HttpServerKeepAliveHandler.html">HttpServerKeepAliveHandler).

  25. val keepAlive: Boolean
  26. def logWarningOnFatalError(enable: Boolean): Config

    Log a warning in case of fatal errors when an error response cannot be sent back to the client

  27. val logWarningOnFatalError: Boolean
  28. def maxHeaderSize(headerSize: Int): Config

    Configure the server to use maxHeaderSize value when encode/decode headers.

  29. val maxHeaderSize: Int
  30. def maxInitialLineLength(initialLineLength: Int): Config
  31. val maxInitialLineLength: Int
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def noIdleTimeout: Config
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  36. def onAnyOpenPort: Config

    Configure the server to listen on an available open port

  37. def port(port: Int): Config

    Configure the server to listen on the provided port.

  38. def productElementNames: Iterator[String]
    Definition Classes
    Product
  39. def requestDecompression(isStrict: Boolean): Config

    Configure the server to use netty's HttpContentDecompressor to decompress Http requests (@see HttpContentDecompressor).

  40. val requestDecompression: Decompression
  41. def requestStreaming(requestStreaming: RequestStreaming): Config

    Enables or disables request body streaming

  42. val requestStreaming: RequestStreaming
  43. def responseCompression(rCfg: ResponseCompressionConfig = Config.ResponseCompressionConfig.default): Config

    Configure the new server with netty's HttpContentCompressor to compress Http responses (@see ).

  44. val responseCompression: Option[ResponseCompressionConfig]
  45. def soBacklog(value: Int): Config

    Sets the maximum number of connection requests that will be queued before being rejected

  46. val soBacklog: Int
  47. def ssl(sslConfig: SSLConfig): Config

    Configure the server with the following ssl options.

  48. val sslConfig: Option[SSLConfig]
  49. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  50. def tcpNoDelay(value: Boolean): Config

    Configure the server to enable/disable TCP_NODELAY.

    Configure the server to enable/disable TCP_NODELAY. TCP_NODELAY disables Nagle's algorithm, which reduces latency for small messages.

  51. val tcpNoDelay: Boolean
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. def webSocketConfig(webSocketConfig: WebSocketConfig): Config
  56. val webSocketConfig: WebSocketConfig

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped