Configuration Structure Reference


                    
                    
                    tlsConfiguration

TLS configuration, defaults to TLSConfiguration.forClient().

Declaration

Swift

public var tlsConfiguration: Optional<TLSConfiguration>

Show on GitHub


                    
                    
                    redirectConfiguration

Enables following 3xx redirects automatically, defaults to RedirectConfiguration().

Following redirects are supported:

301: Moved Permanently
302: Found
303: See Other
304: Not Modified
305: Use Proxy
307: Temporary Redirect
308: Permanent Redirect

Declaration

Swift

public var redirectConfiguration: RedirectConfiguration

Show on GitHub


                    
                    
                    timeout

Default client timeout, defaults to no read timeout and 10 seconds connect timeout.

Declaration

Swift

public var timeout: Timeout

Show on GitHub


                    
                    
                    connectionPool

Connection pool configuration.

Declaration

Swift

public var connectionPool: ConnectionPool

Show on GitHub


                    
                    
                    proxy

Upstream proxy, defaults to no proxy.

Declaration

Swift

public var proxy: Proxy?

Show on GitHub


                    
                    
                    decompression

Enables automatic body decompression. Supported algorithms are gzip and deflate.

Declaration

Swift

public var decompression: Decompression

Show on GitHub


                    
                    
                    ignoreUncleanSSLShutdown

Ignore TLS unclean shutdown error, defaults to false.

Declaration

Swift

public var ignoreUncleanSSLShutdown: Bool

Show on GitHub


                    
                    
                    init(tlsConfiguration:redirectConfiguration:timeout:connectionPool:proxy:ignoreUncleanSSLShutdown:decompression:)

Undocumented

Declaration

Swift

public init(tlsConfiguration: TLSConfiguration? = nil,
            redirectConfiguration: RedirectConfiguration? = nil,
            timeout: Timeout = Timeout(),
            connectionPool: ConnectionPool = ConnectionPool(),
            proxy: Proxy? = nil,
            ignoreUncleanSSLShutdown: Bool = false,
            decompression: Decompression = .disabled)

Show on GitHub


                    
                    
                    init(tlsConfiguration:redirectConfiguration:timeout:proxy:ignoreUncleanSSLShutdown:decompression:)

Undocumented

Declaration

Swift

public init(tlsConfiguration: TLSConfiguration? = nil,
            redirectConfiguration: RedirectConfiguration? = nil,
            timeout: Timeout = Timeout(),
            proxy: Proxy? = nil,
            ignoreUncleanSSLShutdown: Bool = false,
            decompression: Decompression = .disabled)

Show on GitHub


                    
                    
                    init(certificateVerification:redirectConfiguration:timeout:maximumAllowedIdleTimeInConnectionPool:proxy:ignoreUncleanSSLShutdown:decompression:)

Undocumented

Declaration

Swift

public init(certificateVerification: CertificateVerification,
            redirectConfiguration: RedirectConfiguration? = nil,
            timeout: Timeout = Timeout(),
            maximumAllowedIdleTimeInConnectionPool: TimeAmount = .seconds(60),
            proxy: Proxy? = nil,
            ignoreUncleanSSLShutdown: Bool = false,
            decompression: Decompression = .disabled)

Show on GitHub


                    
                    
                    init(certificateVerification:redirectConfiguration:timeout:connectionPool:proxy:ignoreUncleanSSLShutdown:decompression:backgroundActivityLogger:)

Undocumented

Declaration

Swift

public init(certificateVerification: CertificateVerification,
            redirectConfiguration: RedirectConfiguration? = nil,
            timeout: Timeout = Timeout(),
            connectionPool: TimeAmount = .seconds(60),
            proxy: Proxy? = nil,
            ignoreUncleanSSLShutdown: Bool = false,
            decompression: Decompression = .disabled,
            backgroundActivityLogger: Logger?)

Show on GitHub


                    
                    
                    init(certificateVerification:redirectConfiguration:timeout:proxy:ignoreUncleanSSLShutdown:decompression:)

Undocumented

Declaration

Swift

public init(certificateVerification: CertificateVerification,
            redirectConfiguration: RedirectConfiguration? = nil,
            timeout: Timeout = Timeout(),
            proxy: Proxy? = nil,
            ignoreUncleanSSLShutdown: Bool = false,
            decompression: Decompression = .disabled)

Show on GitHub


                    
                    
                    Timeout

Timeout configuration.

Declaration

Swift

public struct Timeout

Show on GitHub


                    
                    
                    RedirectConfiguration

Specifies redirect processing settings.

Declaration

Swift

public struct RedirectConfiguration

Show on GitHub


                    
                    
                    ConnectionPool

Connection pool configuration.

Declaration

Swift

public struct ConnectionPool : Hashable

Show on GitHub


                    
                    
                    Proxy

Proxy server configuration Specifies the remote address of an HTTP proxy.

Adding an Proxy to your client’s HTTPClient.Configuration will cause requests to be passed through the specified proxy using the HTTP CONNECT method.

If a TLSConfiguration is used in conjunction with HTTPClient.Configuration.Proxy, TLS will be established after successful proxy, between your client and the destination server.

Declaration

Swift

public struct Proxy

Show on GitHub