Skip to content

Add helpers for working with loop bound values #3215

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
101 changes: 101 additions & 0 deletions Sources/NIOCore/NIOLoopBound.swift
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,56 @@ public struct NIOLoopBound<Value>: @unchecked Sendable {
yield &self._value
}
}

/// Executes the closure on the event loop the value is bound to.
@inlinable
public func execute(_ task: @escaping @Sendable (Value) -> Void) {
if self.eventLoop.inEventLoop {
task(self._value)
} else {
self.eventLoop.execute {
task(self._value)
}
}
}

/// Executes the closure on the event loop the value is bound to and returns the result in
/// a future.
///
/// - Parameter task: The task to execute on the event loop with the loop bound value.
/// - Returns: A future containing the result of the task.
@inlinable
public func submit<Result: Sendable>(
_ task: @escaping @Sendable (Value) throws -> Result
) -> EventLoopFuture<Result> {
if self.eventLoop.inEventLoop {
self.eventLoop.makeCompletedFuture {
try task(self._value)
}
} else {
self.eventLoop.submit {
try task(self._value)
}
}
}

/// Executes the closure on the event loop the value is bound to and returns the result in
/// a future.
///
/// - Parameter task: The task to execute on the event loop with the loop bound value.
/// - Returns: A future containing the result of the task.
@inlinable
public func flatSubmit<Result: Sendable>(
_ task: @escaping @Sendable (Value) -> EventLoopFuture<Result>
) -> EventLoopFuture<Result> {
if self.eventLoop.inEventLoop {
task(self._value)
} else {
self.eventLoop.flatSubmit {
task(self._value)
}
}
}
}

/// ``NIOLoopBoundBox`` is an always-`Sendable`, reference-typed container allowing you access to ``value`` if and
Expand Down Expand Up @@ -175,4 +225,55 @@ public final class NIOLoopBoundBox<Value>: @unchecked Sendable {
yield &self._value
}
}

/// Executes the closure on the event loop the value is bound to.
@inlinable
public func execute(_ task: @escaping @Sendable (Value) -> Void) {
if self.eventLoop.inEventLoop {
task(self._value)
} else {
self.eventLoop.execute {
task(self._value)
}
}
}

/// Executes the closure on the event loop the value is bound to and returns the result in
/// a future.
///
/// - Parameter task: The task to execute on the event loop with the loop bound value.
/// - Returns: A future containing the result of the task.
@inlinable
public func submit<Result: Sendable>(
_ task: @escaping @Sendable (Value) throws -> Result
) -> EventLoopFuture<Result> {
if self.eventLoop.inEventLoop {
self.eventLoop.makeCompletedFuture {
try task(self._value)
}
} else {
self.eventLoop.submit {
try task(self._value)
}
}
}

/// Executes the closure on the event loop the value is bound to and returns the result in
/// a future.
///
/// - Parameter task: The task to execute on the event loop with the loop bound value.
/// - Returns: A future containing the result of the task.
@inlinable
public func flatSubmit<Result: Sendable>(
_ task: @escaping @Sendable (Value) -> EventLoopFuture<Result>
) -> EventLoopFuture<Result> {
if self.eventLoop.inEventLoop {
task(self._value)
} else {
self.eventLoop.flatSubmit {
task(self._value)
}
}
}

}
51 changes: 51 additions & 0 deletions Tests/NIOPosixTests/NIOLoopBoundTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,46 @@ final class NIOLoopBoundTests: XCTestCase {
XCTAssertTrue(loopBoundBox.value.mutateInPlace())
}

func testExecute() {
let loopBound = NIOLoopBound(Ref(31), eventLoop: self.loop)
loopBound.execute { ref in
XCTAssertEqual(ref.value, 31)
ref.value = 415
}
XCTAssertEqual(loopBound.value.value, 415)

let loopBoundBox = NIOLoopBoundBox(Ref(31), eventLoop: self.loop)
loopBoundBox.execute { ref in
XCTAssertEqual(ref.value, 31)
ref.value = 415
}
XCTAssertEqual(loopBoundBox.value.value, 415)
}

func testSubmit() throws {
let loopBound = NIOLoopBound(Ref(42), eventLoop: self.loop)
let value1 = try loopBound.submit { $0.value }.wait()
XCTAssertEqual(value1, 42)

let loopBoundBox = NIOLoopBoundBox(Ref(42), eventLoop: self.loop)
let value2 = try loopBoundBox.submit { $0.value }.wait()
XCTAssertEqual(value2, 42)
}

func testFlatSubmit() throws {
let loopBound = NIOLoopBound(Ref(42), eventLoop: self.loop)
let value1 = try loopBound.flatSubmit { [loop] ref in
loop!.makeSucceededFuture(ref.value)
}.wait()
XCTAssertEqual(value1, 42)

let loopBoundBox = NIOLoopBoundBox(Ref(42), eventLoop: self.loop)
let value2 = try loopBoundBox.flatSubmit { [loop] ref in
loop!.makeSucceededFuture(ref.value)
}.wait()
XCTAssertEqual(value2, 42)
}

// MARK: - Helpers
func sendableBlackhole<S: Sendable>(_ sendableThing: S) {}

Expand All @@ -134,3 +174,14 @@ final class NotSendable {}

@available(*, unavailable)
extension NotSendable: Sendable {}

final class Ref<Value> {
var value: Value

init(_ value: Value) {
self.value = value
}
}

@available(*, unavailable)
extension Ref: Sendable {}
Loading