Skip to content

Commit a40e45f

Browse files
committed
fix docs
1 parent f81410f commit a40e45f

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

Sources/GRPCCore/GRPCClient.swift

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ private import Synchronization
3030
///
3131
/// ## Creating a client
3232
///
33-
/// You can create and run a client using ``withGRPCClient(transport:interceptors:handleClient:)``
34-
/// or ``withGRPCClient(transport:interceptorPipeline:handleClient:)`` which create, configure and
33+
/// You can create and run a client using ``withGRPCClient(transport:interceptors:isolation:handleClient:)``
34+
/// or ``withGRPCClient(transport:interceptorPipeline:isolation:handleClient:)`` which create, configure and
3535
/// run the client providing scoped access to it via the `handleClient` closure. The client will
3636
/// begin gracefully shutting down when the closure returns.
3737
///
@@ -381,6 +381,8 @@ public final class GRPCClient: Sendable {
381381
/// are called. The first interceptor added will be the first interceptor to intercept each
382382
/// request. The last interceptor added will be the final interceptor to intercept each
383383
/// request before calling the appropriate handler.
384+
/// - isolation: A reference to the actor to which the enclosing code is isolated, or nil if the
385+
/// code is nonisolated.
384386
/// - handleClient: A closure which is called with the client. When the closure returns, the
385387
/// client is shutdown gracefully.
386388
public func withGRPCClient<Result: Sendable>(
@@ -406,6 +408,8 @@ public func withGRPCClient<Result: Sendable>(
406408
/// The order in which interceptors are added reflects the order in which they are called.
407409
/// The first interceptor added will be the first interceptor to intercept each request.
408410
/// The last interceptor added will be the final interceptor to intercept each request before calling the appropriate handler.
411+
/// - isolation: A reference to the actor to which the enclosing code is isolated, or nil if the
412+
/// code is nonisolated.
409413
/// - handleClient: A closure which is called with the client. When the closure returns, the
410414
/// client is shutdown gracefully.
411415
/// - Returns: The result of the `handleClient` closure.

Sources/GRPCCore/GRPCServer.swift

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,8 @@ public final class GRPCServer: Sendable {
251251
/// are called. The first interceptor added will be the first interceptor to intercept each
252252
/// request. The last interceptor added will be the final interceptor to intercept each
253253
/// request before calling the appropriate handler.
254+
/// - isolation: A reference to the actor to which the enclosing code is isolated, or nil if the
255+
/// code is nonisolated.
254256
/// - handleServer: A closure which is called with the server. When the closure returns, the
255257
/// server is shutdown gracefully.
256258
/// - Returns: The result of the `handleServer` closure.
@@ -280,6 +282,8 @@ public func withGRPCServer<Result: Sendable>(
280282
/// are called. The first interceptor added will be the first interceptor to intercept each
281283
/// request. The last interceptor added will be the final interceptor to intercept each
282284
/// request before calling the appropriate handler.
285+
/// - isolation: A reference to the actor to which the enclosing code is isolated, or nil if the
286+
/// code is nonisolated.
283287
/// - handleServer: A closure which is called with the server. When the closure returns, the
284288
/// server is shutdown gracefully.
285289
/// - Returns: The result of the `handleServer` closure.

0 commit comments

Comments
 (0)