Skip to content

Commit

Permalink
Remove outdated documentation (#3023)
Browse files Browse the repository at this point in the history
Removes an outdated recommendation about shutting down
`MultiThreadedEventLoopGroup`s before the program exits. It's now
considered best practice to just exit the application and allow the host
OS to do resource clean up.
  • Loading branch information
rauhul authored Dec 11, 2024
1 parent 29c65ed commit b2356d9
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions Sources/NIOPosix/MultiThreadedEventLoopGroup.swift
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@ typealias ThreadInitializer = (NIOThread) -> Void
/// all run their own `EventLoop`. Those threads will not be shut down until `shutdownGracefully` or
/// `syncShutdownGracefully` is called.
///
/// - Note: It's good style to call `MultiThreadedEventLoopGroup.shutdownGracefully` or
/// `MultiThreadedEventLoopGroup.syncShutdownGracefully` when you no longer need this `EventLoopGroup`. In
/// many cases that is just before your program exits.
/// - warning: Unit tests often spawn one `MultiThreadedEventLoopGroup` per unit test to force isolation between the
/// tests. In those cases it's important to shut the `MultiThreadedEventLoopGroup` down at the end of the
/// test. A good place to start a `MultiThreadedEventLoopGroup` is the `setUp` method of your `XCTestCase`
Expand Down

0 comments on commit b2356d9

Please sign in to comment.