File: HTTPClientConfiguration.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (51 lines) | stat: -rw-r--r-- 2,165 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Foundation

public struct HTTPClientConfiguration: Sendable {
    // FIXME: this should be unified with ``AuthorizationProvider`` protocol or renamed to avoid unintended shadowing.
    public typealias AuthorizationProvider = @Sendable (URL)
        -> String?

    public init(
        requestHeaders: HTTPClientHeaders? = nil,
        requestTimeout: SendableTimeInterval? = nil,
        authorizationProvider: AuthorizationProvider? = nil,
        retryStrategy: HTTPClientRetryStrategy? = nil,
        circuitBreakerStrategy: HTTPClientCircuitBreakerStrategy? = nil,
        maxConcurrentRequests: Int? = nil
    ) {
        self.requestHeaders = requestHeaders
        self.requestTimeout = requestTimeout
        self.authorizationProvider = authorizationProvider
        self.retryStrategy = retryStrategy
        self.circuitBreakerStrategy = circuitBreakerStrategy
        self.maxConcurrentRequests = maxConcurrentRequests
    }

    public var requestHeaders: HTTPClientHeaders?
    // FIXME: replace with `Duration` when that's available for back-deployment or minimum macOS is bumped to 13.0+
    public var requestTimeout: SendableTimeInterval?
    public var authorizationProvider: AuthorizationProvider?
    public var retryStrategy: HTTPClientRetryStrategy?
    public var circuitBreakerStrategy: HTTPClientCircuitBreakerStrategy?
    public var maxConcurrentRequests: Int?
}

public enum HTTPClientRetryStrategy: Sendable {
    case exponentialBackoff(maxAttempts: Int, baseDelay: SendableTimeInterval)
}

public enum HTTPClientCircuitBreakerStrategy: Sendable {
    case hostErrors(maxErrors: Int, age: SendableTimeInterval)
}