Skip to content

Commit c9a9bf0

Browse files
authored
rename connection pool configuration (#288)
1 parent f69b68f commit c9a9bf0

File tree

4 files changed

+14
-13
lines changed

4 files changed

+14
-13
lines changed

Diff for: Sources/AsyncHTTPClient/ConnectionPool.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ class HTTP1ConnectionProvider {
353353
case .park(let connection):
354354
logger.trace("parking connection",
355355
metadata: ["ahc-connection": "\(connection)"])
356-
connection.setIdleTimeout(timeout: self.configuration.poolConfiguration.idleTimeout,
356+
connection.setIdleTimeout(timeout: self.configuration.connectionPool.idleTimeout,
357357
logger: self.backgroundActivityLogger)
358358
case .closeProvider:
359359
logger.debug("closing provider",
@@ -365,7 +365,7 @@ class HTTP1ConnectionProvider {
365365
logger.trace("parking connection & doing further action",
366366
metadata: ["ahc-connection": "\(connection)",
367367
"ahc-action": "\(action)"])
368-
connection.setIdleTimeout(timeout: self.configuration.poolConfiguration.idleTimeout,
368+
connection.setIdleTimeout(timeout: self.configuration.connectionPool.idleTimeout,
369369
logger: self.backgroundActivityLogger)
370370
self.execute(action, logger: logger)
371371
case .closeAnd(let connection, let action):

Diff for: Sources/AsyncHTTPClient/HTTPClient.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ public class HTTPClient {
642642
/// Default client timeout, defaults to no timeouts.
643643
public var timeout: Timeout
644644
/// Connection pool configuration.
645-
public var poolConfiguration: PoolConfiguration
645+
public var connectionPool: ConnectionPool
646646
/// Upstream proxy, defaults to no proxy.
647647
public var proxy: Proxy?
648648
/// Enables automatic body decompression. Supported algorithms are gzip and deflate.
@@ -653,14 +653,14 @@ public class HTTPClient {
653653
public init(tlsConfiguration: TLSConfiguration? = nil,
654654
redirectConfiguration: RedirectConfiguration? = nil,
655655
timeout: Timeout = Timeout(),
656-
poolConfiguration: PoolConfiguration = PoolConfiguration(),
656+
connectionPool: ConnectionPool = ConnectionPool(),
657657
proxy: Proxy? = nil,
658658
ignoreUncleanSSLShutdown: Bool = false,
659659
decompression: Decompression = .disabled) {
660660
self.tlsConfiguration = tlsConfiguration
661661
self.redirectConfiguration = redirectConfiguration ?? RedirectConfiguration()
662662
self.timeout = timeout
663-
self.poolConfiguration = poolConfiguration
663+
self.connectionPool = connectionPool
664664
self.proxy = proxy
665665
self.ignoreUncleanSSLShutdown = ignoreUncleanSSLShutdown
666666
self.decompression = decompression
@@ -676,7 +676,7 @@ public class HTTPClient {
676676
tlsConfiguration: tlsConfiguration,
677677
redirectConfiguration: redirectConfiguration,
678678
timeout: timeout,
679-
poolConfiguration: PoolConfiguration(),
679+
connectionPool: ConnectionPool(),
680680
proxy: proxy,
681681
ignoreUncleanSSLShutdown: ignoreUncleanSSLShutdown,
682682
decompression: decompression
@@ -693,7 +693,7 @@ public class HTTPClient {
693693
self.init(tlsConfiguration: TLSConfiguration.forClient(certificateVerification: certificateVerification),
694694
redirectConfiguration: redirectConfiguration,
695695
timeout: timeout,
696-
poolConfiguration: PoolConfiguration(),
696+
connectionPool: ConnectionPool(),
697697
proxy: proxy,
698698
ignoreUncleanSSLShutdown: ignoreUncleanSSLShutdown,
699699
decompression: decompression)
@@ -702,15 +702,15 @@ public class HTTPClient {
702702
public init(certificateVerification: CertificateVerification,
703703
redirectConfiguration: RedirectConfiguration? = nil,
704704
timeout: Timeout = Timeout(),
705-
poolConfiguration: TimeAmount = .seconds(60),
705+
connectionPool: TimeAmount = .seconds(60),
706706
proxy: Proxy? = nil,
707707
ignoreUncleanSSLShutdown: Bool = false,
708708
decompression: Decompression = .disabled,
709709
backgroundActivityLogger: Logger?) {
710710
self.init(tlsConfiguration: TLSConfiguration.forClient(certificateVerification: certificateVerification),
711711
redirectConfiguration: redirectConfiguration,
712712
timeout: timeout,
713-
poolConfiguration: PoolConfiguration(),
713+
connectionPool: ConnectionPool(),
714714
proxy: proxy,
715715
ignoreUncleanSSLShutdown: ignoreUncleanSSLShutdown,
716716
decompression: decompression)
@@ -862,7 +862,7 @@ extension HTTPClient.Configuration {
862862
}
863863

864864
/// Connection pool configuration.
865-
public struct PoolConfiguration: Hashable {
865+
public struct ConnectionPool: Hashable {
866866
// Specifies amount of time connections are kept idle in the pool.
867867
public var idleTimeout: TimeAmount
868868

Diff for: Tests/AsyncHTTPClientTests/HTTPClientTests.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -1742,7 +1742,7 @@ class HTTPClientTests: XCTestCase {
17421742

17431743
func testPoolClosesIdleConnections() {
17441744
let localClient = HTTPClient(eventLoopGroupProvider: .shared(self.clientGroup),
1745-
configuration: .init(poolConfiguration: .init(idleTimeout: .milliseconds(100))))
1745+
configuration: .init(connectionPool: .init(idleTimeout: .milliseconds(100))))
17461746
defer {
17471747
XCTAssertNoThrow(try localClient.syncShutdown())
17481748
}
@@ -1753,7 +1753,7 @@ class HTTPClientTests: XCTestCase {
17531753

17541754
func testRacePoolIdleConnectionsAndGet() {
17551755
let localClient = HTTPClient(eventLoopGroupProvider: .shared(self.clientGroup),
1756-
configuration: .init(poolConfiguration: .init(idleTimeout: .milliseconds(10))))
1756+
configuration: .init(connectionPool: .init(idleTimeout: .milliseconds(10))))
17571757
defer {
17581758
XCTAssertNoThrow(try localClient.syncShutdown())
17591759
}

Diff for: docker/Dockerfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools
1818

1919
# ruby and jazzy for docs generation
2020
RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev
21-
RUN gem install jazzy --no-ri --no-rdoc
21+
# jazzy no longer works on xenial as ruby is too old.
22+
RUN if [ "${ubuntu_version}" != "xenial" ] ; then gem install jazzy --no-ri --no-rdoc ; fi
2223

2324
# tools
2425
RUN mkdir -p $HOME/.tools

0 commit comments

Comments
 (0)