Skip to content

Commit e7e53d0

Browse files
committed
Rename to GRPCClient
1 parent 86c5d1d commit e7e53d0

19 files changed

+68
-69
lines changed

Sources/GRPCCore/Call/Client/Internal/ClientRPCExecutor+HedgingExecutor.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extension ClientRPCExecutor {
3030
@usableFromInline
3131
let transport: Transport
3232
@usableFromInline
33-
let policy: Client.MethodConfiguration.HedgingPolicy
33+
let policy: GRPCClient.MethodConfiguration.HedgingPolicy
3434
@usableFromInline
3535
let timeout: Duration?
3636
@usableFromInline
@@ -45,7 +45,7 @@ extension ClientRPCExecutor {
4545
@inlinable
4646
init(
4747
transport: Transport,
48-
policy: Client.MethodConfiguration.HedgingPolicy,
48+
policy: GRPCClient.MethodConfiguration.HedgingPolicy,
4949
timeout: Duration?,
5050
interceptors: [any ClientInterceptor],
5151
serializer: Serializer,
@@ -420,7 +420,7 @@ extension ClientRPCExecutor.HedgingExecutor {
420420
private(set) var hasUsableResponse: Bool
421421

422422
@inlinable
423-
init(policy: Client.MethodConfiguration.HedgingPolicy) {
423+
init(policy: GRPCClient.MethodConfiguration.HedgingPolicy) {
424424
self._maximumAttempts = policy.maximumAttempts
425425
self.attempt = 1
426426
self.hasUsableResponse = false

Sources/GRPCCore/Call/Client/Internal/ClientRPCExecutor+RetryExecutor.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extension ClientRPCExecutor {
3030
@usableFromInline
3131
let transport: Transport
3232
@usableFromInline
33-
let policy: Client.MethodConfiguration.RetryPolicy
33+
let policy: GRPCClient.MethodConfiguration.RetryPolicy
3434
@usableFromInline
3535
let timeout: Duration?
3636
@usableFromInline
@@ -45,7 +45,7 @@ extension ClientRPCExecutor {
4545
@inlinable
4646
init(
4747
transport: Transport,
48-
policy: Client.MethodConfiguration.RetryPolicy,
48+
policy: GRPCClient.MethodConfiguration.RetryPolicy,
4949
timeout: Duration?,
5050
interceptors: [any ClientInterceptor],
5151
serializer: Serializer,

Sources/GRPCCore/Call/Client/Internal/ClientRPCExecutor.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ enum ClientRPCExecutor {
3535
static func execute<Input: Sendable, Output: Sendable, Result: Sendable>(
3636
request: ClientRequest.Stream<Input>,
3737
method: MethodDescriptor,
38-
configuration: Client.MethodConfiguration,
38+
configuration: GRPCClient.MethodConfiguration,
3939
serializer: some MessageSerializer<Input>,
4040
deserializer: some MessageDeserializer<Output>,
4141
transport: some ClientTransport,

Sources/GRPCCore/Call/Client/Internal/RetryDelaySequence.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ struct RetryDelaySequence: Sequence {
2626
typealias Element = Duration
2727

2828
@usableFromInline
29-
let policy: Client.MethodConfiguration.RetryPolicy
29+
let policy: GRPCClient.MethodConfiguration.RetryPolicy
3030

3131
@inlinable
32-
init(policy: Client.MethodConfiguration.RetryPolicy) {
32+
init(policy: GRPCClient.MethodConfiguration.RetryPolicy) {
3333
self.policy = policy
3434
}
3535

@@ -41,12 +41,12 @@ struct RetryDelaySequence: Sequence {
4141
@usableFromInline
4242
struct Iterator: IteratorProtocol {
4343
@usableFromInline
44-
let policy: Client.MethodConfiguration.RetryPolicy
44+
let policy: GRPCClient.MethodConfiguration.RetryPolicy
4545
@usableFromInline
4646
private(set) var n = 1
4747

4848
@inlinable
49-
init(policy: Client.MethodConfiguration.RetryPolicy) {
49+
init(policy: GRPCClient.MethodConfiguration.RetryPolicy) {
5050
self.policy = policy
5151
}
5252

Sources/GRPCCore/Client.swift renamed to Sources/GRPCCore/GRPCClient.swift

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
/// A gRPC client.
1818
///
19-
/// A ``Client`` communicates to a server via a given ``ClientTransport``.
19+
/// A ``GRPCClient`` communicates to a server via a given ``ClientTransport``.
2020
/// You can start RPCs to the server by calling the corresponding method:
2121
/// - ``unary(request:descriptor:serializer:deserializer:handler:)``
2222
/// - ``clientStreaming(request:descriptor:serializer:deserializer:handler:)``
@@ -35,7 +35,7 @@
3535
/// ```swift
3636
/// // Create and add an in-process transport.
3737
/// let inProcessTransport = InProcessClientTransport()
38-
/// let client = Client(transport: inProcessTransport)
38+
/// let client = GRPCClient(transport: inProcessTransport)
3939
///
4040
/// // Create and add some interceptors.
4141
/// client.interceptors.add(StatsRecordingServerInterceptors())
@@ -66,7 +66,7 @@
6666
/// that need their lifecycles managed you should consider using [Swift Service
6767
/// Lifecycle](https://github.com/swift-server/swift-service-lifecycle).
6868
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
69-
public final class Client: Sendable {
69+
public final class GRPCClient: Sendable {
7070
/// A collection of ``ClientInterceptor`` implementations which are applied to all accepted
7171
/// RPCs.
7272
///
@@ -142,7 +142,7 @@ public final class Client: Sendable {
142142
///
143143
/// - Note: Any changes to resources after ``run()`` has been called will be ignored.
144144
///
145-
/// - Parameter transport: The ``ClientTransport`` to be used for this ``Client``.
145+
/// - Parameter transport: The ``ClientTransport`` to be used for this ``GRPCClient``.
146146
public init(transport: ClientTransport) {
147147
self.storage = LockedValueBox(Storage())
148148
self.transport = transport
@@ -155,11 +155,10 @@ public final class Client: Sendable {
155155
///
156156
/// If you need to immediately stop all work, cancel the task executing this method.
157157
public func run() async throws {
158-
let interceptors = try self.storage.withLockedValue { storage in
158+
try self.storage.withLockedValue { storage in
159159
switch storage.state {
160160
case .notStarted:
161161
storage.state = .running
162-
return storage.interceptors
163162
case .running:
164163
throw ClientError(
165164
code: .clientIsAlreadyRunning,
@@ -436,7 +435,7 @@ public final class Client: Sendable {
436435
}
437436

438437
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
439-
extension Client {
438+
extension GRPCClient {
440439
/// A collection of interceptors providing cross-cutting functionality to each accepted RPC.
441440
public struct Interceptors: Sendable {
442441
private(set) var values: [any ClientInterceptor] = []
@@ -456,7 +455,7 @@ extension Client {
456455
}
457456

458457
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
459-
extension Client {
458+
extension GRPCClient {
460459
/// The execution policy for an RPC.
461460
public enum ExecutionPolicy: Hashable, Sendable {
462461
/// Policy for retrying an RPC.
@@ -544,7 +543,7 @@ extension Client {
544543
}
545544

546545
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
547-
extension Client.MethodConfiguration {
546+
extension GRPCClient.MethodConfiguration {
548547
/// Policy for retrying an RPC.
549548
///
550549
/// gRPC retries RPCs when the first response from the server is a status code which matches
@@ -720,7 +719,7 @@ extension Client.MethodConfiguration {
720719
}
721720

722721
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
723-
extension Client {
722+
extension GRPCClient {
724723
/// A collection of ``ClientRPCExecutionConfiguration``s, mapped to specific methods or services.
725724
///
726725
/// When creating a new instance, you must provide a default configuration to be used when getting

Sources/GRPCCore/GRPCServer.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import Atomics
2323
/// streams to a service to handle the RPC or rejects them with an appropriate error if no service
2424
/// can handle the RPC.
2525
///
26-
/// A ``Server`` may listen with multiple transports (for example, HTTP/2 and in-process) and route
26+
/// A ``GRPCServer`` may listen with multiple transports (for example, HTTP/2 and in-process) and route
2727
/// requests from each transport to the same service instance. You can also use "interceptors",
2828
/// to implement cross-cutting logic which apply to all accepted RPCs. Example uses of interceptors
2929
/// include request filtering, authentication, and logging. Once requests have been intercepted

Sources/GRPCCore/Transport/ClientTransport.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,5 @@ public protocol ClientTransport: Sendable {
7777
/// - Returns: Execution configuration for the method, if it exists.
7878
func executionConfiguration(
7979
forMethod descriptor: MethodDescriptor
80-
) -> Client.MethodConfiguration?
80+
) -> GRPCClient.MethodConfiguration?
8181
}

Sources/GRPCCore/Transport/InProcessClientTransport.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ public struct InProcessClientTransport: ClientTransport {
9696

9797
public let retryThrottle: RetryThrottle
9898

99-
private let executionConfigurations: Client.MethodConfigurationRegistry
99+
private let executionConfigurations: GRPCClient.MethodConfigurationRegistry
100100
private let state: LockedValueBox<State>
101101

102102
public init(
103103
server: InProcessServerTransport,
104-
executionConfigurations: Client.MethodConfigurationRegistry
104+
executionConfigurations: GRPCClient.MethodConfigurationRegistry
105105
) {
106106
self.retryThrottle = RetryThrottle(maximumTokens: 10, tokenRatio: 0.1)
107107
self.executionConfigurations = executionConfigurations
@@ -329,7 +329,7 @@ public struct InProcessClientTransport: ClientTransport {
329329
/// - Returns: Execution configuration for the method, if it exists.
330330
public func executionConfiguration(
331331
forMethod descriptor: MethodDescriptor
332-
) -> Client.MethodConfiguration? {
332+
) -> GRPCClient.MethodConfiguration? {
333333
self.executionConfigurations[descriptor]
334334
}
335335
}

Tests/GRPCCoreTests/Call/Client/ClientRPCExecutionConfigurationCollectionTests.swift

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,73 +24,73 @@ final class ClientRPCExecutionConfigurationCollectionTests: XCTestCase {
2424
let result = second.duration(to: first)
2525
print(result.components)
2626

27-
let policy = Client.MethodConfiguration.HedgingPolicy(
27+
let policy = GRPCClient.MethodConfiguration.HedgingPolicy(
2828
maximumAttempts: 10,
2929
hedgingDelay: .seconds(1),
3030
nonFatalStatusCodes: []
3131
)
32-
let defaultConfiguration = Client.MethodConfiguration(hedgingPolicy: policy)
33-
var configurations = Client.MethodConfigurationRegistry(
32+
let defaultConfiguration = GRPCClient.MethodConfiguration(hedgingPolicy: policy)
33+
var configurations = GRPCClient.MethodConfigurationRegistry(
3434
defaultConfiguration: defaultConfiguration
3535
)
3636
let descriptor = MethodDescriptor(service: "test", method: "first")
37-
let retryPolicy = Client.MethodConfiguration.RetryPolicy(
37+
let retryPolicy = GRPCClient.MethodConfiguration.RetryPolicy(
3838
maximumAttempts: 10,
3939
initialBackoff: .seconds(1),
4040
maximumBackoff: .seconds(1),
4141
backoffMultiplier: 1.0,
4242
retryableStatusCodes: [.unavailable]
4343
)
44-
let overrideConfiguration = Client.MethodConfiguration(retryPolicy: retryPolicy)
44+
let overrideConfiguration = GRPCClient.MethodConfiguration(retryPolicy: retryPolicy)
4545
configurations[descriptor] = overrideConfiguration
4646

4747
XCTAssertEqual(configurations[descriptor], overrideConfiguration)
4848
}
4949

5050
func testGetConfigurationForUnknownMethodButServiceOverride() {
51-
let policy = Client.MethodConfiguration.HedgingPolicy(
51+
let policy = GRPCClient.MethodConfiguration.HedgingPolicy(
5252
maximumAttempts: 10,
5353
hedgingDelay: .seconds(1),
5454
nonFatalStatusCodes: []
5555
)
56-
let defaultConfiguration = Client.MethodConfiguration(hedgingPolicy: policy)
57-
var configurations = Client.MethodConfigurationRegistry(
56+
let defaultConfiguration = GRPCClient.MethodConfiguration(hedgingPolicy: policy)
57+
var configurations = GRPCClient.MethodConfigurationRegistry(
5858
defaultConfiguration: defaultConfiguration
5959
)
6060
let firstDescriptor = MethodDescriptor(service: "test", method: "")
61-
let retryPolicy = Client.MethodConfiguration.RetryPolicy(
61+
let retryPolicy = GRPCClient.MethodConfiguration.RetryPolicy(
6262
maximumAttempts: 10,
6363
initialBackoff: .seconds(1),
6464
maximumBackoff: .seconds(1),
6565
backoffMultiplier: 1.0,
6666
retryableStatusCodes: [.unavailable]
6767
)
68-
let overrideConfiguration = Client.MethodConfiguration(retryPolicy: retryPolicy)
68+
let overrideConfiguration = GRPCClient.MethodConfiguration(retryPolicy: retryPolicy)
6969
configurations[firstDescriptor] = overrideConfiguration
7070

7171
let secondDescriptor = MethodDescriptor(service: "test", method: "second")
7272
XCTAssertEqual(configurations[secondDescriptor], overrideConfiguration)
7373
}
7474

7575
func testGetConfigurationForUnknownMethodDefaultValue() {
76-
let policy = Client.MethodConfiguration.HedgingPolicy(
76+
let policy = GRPCClient.MethodConfiguration.HedgingPolicy(
7777
maximumAttempts: 10,
7878
hedgingDelay: .seconds(1),
7979
nonFatalStatusCodes: []
8080
)
81-
let defaultConfiguration = Client.MethodConfiguration(hedgingPolicy: policy)
82-
var configurations = Client.MethodConfigurationRegistry(
81+
let defaultConfiguration = GRPCClient.MethodConfiguration(hedgingPolicy: policy)
82+
var configurations = GRPCClient.MethodConfigurationRegistry(
8383
defaultConfiguration: defaultConfiguration
8484
)
8585
let firstDescriptor = MethodDescriptor(service: "test1", method: "first")
86-
let retryPolicy = Client.MethodConfiguration.RetryPolicy(
86+
let retryPolicy = GRPCClient.MethodConfiguration.RetryPolicy(
8787
maximumAttempts: 10,
8888
initialBackoff: .seconds(1),
8989
maximumBackoff: .seconds(1),
9090
backoffMultiplier: 1.0,
9191
retryableStatusCodes: [.unavailable]
9292
)
93-
let overrideConfiguration = Client.MethodConfiguration(retryPolicy: retryPolicy)
93+
let overrideConfiguration = GRPCClient.MethodConfiguration(retryPolicy: retryPolicy)
9494
configurations[firstDescriptor] = overrideConfiguration
9595

9696
let secondDescriptor = MethodDescriptor(service: "test2", method: "second")

Tests/GRPCCoreTests/Call/Client/ClientRPCExecutionConfigurationTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import XCTest
1919
@available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
2020
final class ClientRPCExecutionConfigurationTests: XCTestCase {
2121
func testRetryPolicyClampsMaxAttempts() {
22-
var policy = Client.MethodConfiguration.RetryPolicy(
22+
var policy = GRPCClient.MethodConfiguration.RetryPolicy(
2323
maximumAttempts: 10,
2424
initialBackoff: .seconds(1),
2525
maximumBackoff: .seconds(1),
@@ -35,7 +35,7 @@ final class ClientRPCExecutionConfigurationTests: XCTestCase {
3535
}
3636

3737
func testHedgingPolicyClampsMaxAttempts() {
38-
var policy = Client.MethodConfiguration.HedgingPolicy(
38+
var policy = GRPCClient.MethodConfiguration.HedgingPolicy(
3939
maximumAttempts: 10,
4040
hedgingDelay: .seconds(1),
4141
nonFatalStatusCodes: []

0 commit comments

Comments
 (0)