Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document known Structured Concurrency violations #3108

Merged
merged 1 commit into from
Feb 5, 2025
Merged

document known Structured Concurrency violations #3108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions Sources/NIOCore/AsyncAwaitSupport.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
extension EventLoopFuture {
/// Get the value/error from an `EventLoopFuture` in an `async` context.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// This function can be used to bridge an `EventLoopFuture` into the `async` world. Ie. if you're in an `async`
/// function and want to get the result of this future.
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
Expand All @@ -37,6 +39,9 @@ extension EventLoopFuture {
#if canImport(Dispatch)
extension EventLoopGroup {
/// Shuts down the event loop gracefully.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@inlinable
public func shutdownGracefully() async throws {
Expand Down Expand Up @@ -82,6 +87,8 @@ extension EventLoopPromise {
extension Channel {
/// Shortcut for calling `write` and `flush`.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - data: the data to write
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
Expand Down Expand Up @@ -113,6 +120,9 @@ extension Channel {

extension ChannelOutboundInvoker {
/// Register on an `EventLoop` and so have all its IO handled.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - file: The file this function was called in, for debugging purposes.
/// - line: The line this function was called on, for debugging purposes.
Expand All @@ -122,6 +132,9 @@ extension ChannelOutboundInvoker {
}

/// Bind to a `SocketAddress`.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - address: the `SocketAddress` to which we should bind the `Channel`.
/// - file: The file this function was called in, for debugging purposes.
Expand All @@ -132,6 +145,9 @@ extension ChannelOutboundInvoker {
}

/// Connect to a `SocketAddress`.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - address: the `SocketAddress` to which we should connect the `Channel`.
/// - file: The file this function was called in, for debugging purposes.
Expand All @@ -143,6 +159,8 @@ extension ChannelOutboundInvoker {

/// Shortcut for calling `write` and `flush`.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - data: the data to write
/// - file: The file this function was called in, for debugging purposes.
Expand All @@ -159,6 +177,8 @@ extension ChannelOutboundInvoker {

/// Close the `Channel` and so the connection if one exists.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - mode: the `CloseMode` that is used
/// - file: The file this function was called in, for debugging purposes.
Expand All @@ -170,6 +190,8 @@ extension ChannelOutboundInvoker {

/// Trigger a custom user outbound event which will flow through the `ChannelPipeline`.
///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
/// - Parameters:
/// - event: the event itself.
/// - file: The file this function was called in, for debugging purposes.
Expand All @@ -196,17 +218,26 @@ extension ChannelPipeline {
try await self.addHandler(handler, name: name, position: position).get()
}

///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@preconcurrency
public func removeHandler(_ handler: RemovableChannelHandler & Sendable) async throws {
try await self.removeHandler(handler).get()
}

///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
public func removeHandler(name: String) async throws {
try await self.removeHandler(name: name).get()
}

///
/// - warning: This method currently violates Structured Concurrency because cancellation isn't respected.
///
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@available(
*,
Expand All @@ -224,6 +255,7 @@ extension ChannelPipeline {
message:
"ChannelHandlerContext is not Sendable and it is therefore not safe to be used outside of its EventLoop"
)

@preconcurrency
public func context(handler: ChannelHandler & Sendable) async throws -> ChannelHandlerContext {
try await self.context(handler: handler).map { UnsafeTransfer($0) }.get().wrappedValue
Expand Down
Loading