Proxy server configuration Specifies the remote address of an HTTP proxy.
struct ProxyAdding 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.
import AsyncHTTPClientThis package provides simple HTTP Client library built on top of SwiftNIO.
struct ConfigurationHTTPClient configuration.
class HTTPClientHTTPClient class provides API for request execution.
init(certificateVerification: CertificateVerification, redirectConfiguration: RedirectConfiguration? = nil, timeout: Timeout = Timeout(), connectionPool: TimeAmount = .seconds(60), proxy: Proxy? = nil, ignoreUncleanSSLShutdown: Bool = false, decompression: Decompression = .disabled, backgroundActivityLogger: Logger?) init(certificateVerification: CertificateVerification, redirectConfiguration: RedirectConfiguration? = nil, timeout: Timeout = Timeout(), maximumAllowedIdleTimeInConnectionPool: TimeAmount = .seconds(60), proxy: Proxy? = nil, ignoreUncleanSSLShutdown: Bool = false, decompression: Decompression = .disabled) init(certificateVerification: CertificateVerification, redirectConfiguration: RedirectConfiguration? = nil, timeout: Timeout = Timeout(), proxy: Proxy? = nil, ignoreUncleanSSLShutdown: Bool = false, decompression: Decompression = .disabled) init(tlsConfiguration: TLSConfiguration? = nil, redirectConfiguration: RedirectConfiguration? = nil, timeout: Timeout = Timeout(), connectionPool: ConnectionPool = ConnectionPool(), proxy: Proxy? = nil, ignoreUncleanSSLShutdown: Bool = false, decompression: Decompression = .disabled) init(tlsConfiguration: TLSConfiguration? = nil, redirectConfiguration: RedirectConfiguration? = nil, timeout: Timeout = Timeout(), proxy: Proxy? = nil, ignoreUncleanSSLShutdown: Bool = false, decompression: Decompression = .disabled) static var singletonConfiguration: HTTPClient.Configuration { get }The Configuration for shared which tries to mimic the platform’s default or prevalent browser as closely as possible.
var connectionPool: ConnectionPoolConnection pool configuration.
var decompression: DecompressionEnables automatic body decompression. Supported algorithms are gzip and deflate.
var dnsOverride: [String : String]Sometimes it can be useful to connect to one host e.g. x.example.com but request and validate the certificate chain as if we would connect to y.example.com. dnsOverride allows to do just that by mapping host names which we will request and validate the certificate chain, to a different host name which will be used to actually connect to.
var enableMultipath: BoolWhether HTTPClient will use Multipath TCP or not By default, don’t use it
var httpVersion: HTTPVersionWhat HTTP versions to use.
var maximumUsesPerConnection: Int? { get set }The maximum number of times each connection can be used before it is replaced with a new one. Use nil (the default) if no limit should be applied to each connection.
var networkFrameworkWaitForConnectivity: BoolWhether HTTPClient will let Network.framework sit in the .waiting state awaiting new network changes, or fail immediately. Defaults to true, which is the recommended setting. Only set this to false when attempting to trigger a particular error path.
var proxy: Proxy?Upstream proxy, defaults to no proxy.
var redirectConfiguration: RedirectConfigurationEnables following 3xx redirects automatically.
var timeout: TimeoutDefault client timeout, defaults to no read timeout and 10 seconds connect timeout.
var tlsConfiguration: Optional<TLSConfiguration>TLS configuration, defaults to TLSConfiguration.makeClientConfiguration().
struct ConnectionPoolConnection pool configuration.
struct HTTPVersionstruct RedirectConfigurationSpecifies redirect processing settings.
struct TimeoutTimeout configuration.
var ignoreUncleanSSLShutdown: Bool { get set }Ignore TLS unclean shutdown error, defaults to false.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Sendablestatic func server(host: String, port: Int) -> Proxy Create a HTTP proxy.
static func server(host: String, port: Int, authorization: HTTPClient.Authorization? = nil) -> Proxy Create a HTTP proxy.
static func socksServer(host: String, port: Int = 1080) -> Proxy Create a SOCKSv5 proxy.
var authorization: HTTPClient.Authorization? { get set }Specifies Proxy server authorization.
var host: StringSpecifies Proxy server host.
var port: IntSpecifies Proxy server port.
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.