Structure

HTTPServer.Configuration

Engine server config struct.

struct Configuration

Overview

let serverConfig = HTTPServerConfig.default(port: 8123)
services.register(serverConfig)

Topics

Structures

struct RequestDecompressionConfiguration
Supported HTTP decompression options.
struct ResponseCompressionConfiguration
Supported HTTP response compression options.

Initializers

Instance Properties

var address: BindAddress
Address the server will bind to. Configuring an address using a hostname with a nil host or port will use the default hostname or port respectively.
var backlog: Int
Listen backlog.
var connectionsPerServerTick: UInt
The number of incoming TCP connections to accept per “tick” (i.e. each time through the server’s event loop).
var customCertificateVerifyCallback: (([NIOSSLCertificate], EventLoopPromise<NIOSSLVerificationResult>) -> Void)?
An optional callback that will be called instead of using swift-nio-ssl’s regular certificate verification logic. This is the same as NIOSSLCustomVerificationCallback but just marked as Sendable
var customCertificateVerifyCallbackWithMetadata: (([NIOSSLCertificate], EventLoopPromise<NIOSSLVerificationResultWithMetadata>) -> Void)?
An optional callback that will be called instead of using swift-nio-ssl’s regular certificate verification logic. This is the same as NIOSSLCustomVerificationCallbackWithMetadata but just marked as Sendable.
var hostname: String
Host name the server will bind to.
var idleTimeout: TimeAmount?
When set, inbound connections that have been idle for this duration will be closed. Default: nil (disabled).
var logger: Logger
Any uncaught server or responder errors will go here.
var port: Int
Port the server will bind to.
var reportMetrics: Bool
When true, report http metrics through swift-metrics
var requestDecompression: HTTPServer.Configuration.RequestDecompressionConfiguration
Request decompression configuration.
var responseCompression: HTTPServer.Configuration.ResponseCompressionConfiguration
Response compression configuration.
var reuseAddress: Bool
When true, can prevent errors re-binding to a socket after successive server restarts.
var serverName: String?
If set, this name will be serialized as the Server header in outgoing responses.
var shutdownTimeout: TimeAmount
A time limit to complete a graceful shutdown
var supportPipelining: Bool
When true, HTTP server will support pipelined requests.
var supportVersions: Set<HTTPVersionMajor>
var tcpNoDelay: Bool
When true, OS will attempt to minimize TCP packet delay.
var tlsConfiguration: TLSConfiguration?

HTTPServer.Configuration

Overview

Topics

Structures

Initializers

Instance Properties

Type Aliases

Type Properties

Relationships

Conforms To