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

Clarify when Client.close must be called #1255

Merged
merged 2 commits into from
Jul 4, 2024
Merged

Clarify when Client.close must be called #1255

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c803a15
Clarify when Client.close must be called
brianquinlan Jul 3, 2024
815087a
Review fixes
brianquinlan Jul 3, 2024
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
7 changes: 5 additions & 2 deletions pkgs/http/lib/src/client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ abstract interface class Client {

/// Closes the client and cleans up any resources associated with it.
///
/// It's important to close each client when it's done being used; failing to
/// do so can cause the Dart process to hang.
/// Some clients maintain a pool of network connections that will not be
/// disconnected until the client is closed. This may cause programs using
/// using the Dart SDK (`dart run`, `dart test`, `dart compile`, etc.) to
/// not terminate until the client is closed. Programs run using the Flutter
/// SDK can still terminate even with an active connection pool.
///
/// Once [close] is called, no other methods should be called. If [close] is
/// called while other asynchronous methods are running, the behavior is
Expand Down