zio-http-shaded
API
Generated with
zio-http-shaded/zio.http/Server/Config

Config

zio.http.Server.Config
See theConfig companion object
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: Duration, webSocketConfig: WebSocketConfig, idleTimeout: Option[Duration])

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def acceptContinue(enable: Boolean): Config

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

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

Attributes

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

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

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

Attributes

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

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

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

Attributes

def binding(inetSocketAddress: InetSocketAddress): Config

Configure the server to listen on the provided InetSocketAddress.

Configure the server to listen on the provided InetSocketAddress.

Attributes

def disableRequestStreaming(maxContentLength: Int): Config

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

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

Attributes

def enableRequestStreaming: Config

Enables streaming request bodies

Enables streaming request bodies

Attributes

def idleTimeout(duration: Duration): Config
def keepAlive(enable: Boolean): Config

Configure the server to use netty's HttpServerKeepAliveHandler to close persistent connections when enable is true (@see HttpServerKeepAliveHandler).

Configure the server to use netty's HttpServerKeepAliveHandler to close persistent connections when enable is true (@see HttpServerKeepAliveHandler).

Attributes

def logWarningOnFatalError(enable: Boolean): Config

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

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

Attributes

def maxHeaderSize(headerSize: Int): Config

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

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

Attributes

def maxInitialLineLength(initialLineLength: Int): Config
def onAnyOpenPort: Config

Configure the server to listen on an available open port

Configure the server to listen on an available open port

Attributes

def port(port: Int): Config

Configure the server to listen on the provided port.

Configure the server to listen on the provided port.

Attributes

def requestDecompression(isStrict: Boolean): Config

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

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

Attributes

def requestStreaming(requestStreaming: RequestStreaming): Config

Enables or disables request body streaming

Enables or disables request body streaming

Attributes

def responseCompression(rCfg: ResponseCompressionConfig): Config

Configure the new server with netty's HttpContentCompressor to compress Http responses (@see <a href = "https://netty.io/4.1/api/io/netty/handler/codec/http/HttpContentCompressor.html"HttpContentCompressor).

Configure the new server with netty's HttpContentCompressor to compress Http responses (@see <a href = "https://netty.io/4.1/api/io/netty/handler/codec/http/HttpContentCompressor.html"HttpContentCompressor).

Attributes

def ssl(sslConfig: SSLConfig): Config

Configure the server with the following ssl options.

Configure the server with the following ssl options.

Attributes

def webSocketConfig(webSocketConfig: WebSocketConfig): Config

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with