Skip to content

Commit

Permalink
deprecate NIOEventLoopGroupProvider.createNew (#2480)
Browse files Browse the repository at this point in the history
### Motivation:

`NIOEventLoopGroupProvider.createNew` was probably never a good idea
because it creates shutdown issues for any library that uses it. Given
that we now have singleton (#2471) `EventLoopGroup`s, we can solve this
issue by just not having event loop group providers.

Users can just use `group: any EventLoopGroup` and optionally `group:
any EventLoopGroup = MultiThreadedEventLoopGroup.singleton`.

### Modifications:

- deprecate `NIOEventLoopGroupProvider.createNew`
- soft-deprecate (document as deprecated but don't mark
`@available(deprecated)`) `NIOEventLoopGroupProvider`

### Result:

- Libraries becomes easier to write and maintain.
- Fixes #2142
  • Loading branch information
weissi authored Nov 25, 2024
1 parent 6ba8f4f commit 848e428
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
1 change: 0 additions & 1 deletion Sources/NIOCore/Docs.docc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ More specialized modules provide concrete implementations of many of the abstrac

- ``EventLoopGroup``
- ``EventLoop``
- ``NIOEventLoopGroupProvider``
- ``EventLoopIterator``
- ``Scheduled``
- ``RepeatedTask``
Expand Down
21 changes: 19 additions & 2 deletions Sources/NIOCore/EventLoop.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1246,16 +1246,33 @@ extension EventLoopGroup {
}
#endif

/// This type is intended to be used by libraries which use NIO, and offer their users either the option
/// Deprecated.
///
/// This type was intended to be used by libraries which use NIO, and offer their users either the option
/// to `.share` an existing event loop group or create (and manage) a new one (`.createNew`) and let it be
/// managed by given library and its lifecycle.
///
/// Please use a `group: any EventLoopGroup` parameter instead. If you want to default to a global
/// singleton group instead, consider group: any EventLoopGroup = MultiThreadedEventLoopGroup.singleton` or
/// similar.
///
/// - See also: https://github.com/apple/swift-nio/issues/2142
public enum NIOEventLoopGroupProvider {
/// Use an `EventLoopGroup` provided by the user.
/// The owner of this group is responsible for its lifecycle.
case shared(EventLoopGroup)
/// Create a new `EventLoopGroup` when necessary.

/// Deprecated. Create a new `EventLoopGroup` when necessary.
/// The library which accepts this provider takes ownership of the created event loop group,
/// and must ensure its proper shutdown when the library is being shut down.
@available(
*,
deprecated,
message: """
Please use `.shared(existingGroup)` or use the singleton via \
`.shared(MultiThreadedEventLoopGroup.singleton)` or similar
"""
)
case createNew
}

Expand Down

0 comments on commit 848e428

Please sign in to comment.