connection: clarify documented behavior of NotifyClose #13
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for
NotifyClose()
differs between Channel:and Connection:
The latter wording suggests that on abnormal shutdowns the chan will remain open, with two expected features:
NotifyClose()
so an existing select statement need not update the chan it monitors.In fact the logic for maintaining close notifiers appears identical for both Channel and Connection: both are closed as a result of the underlying object being closed.
This PR updates to use the Channel description in the Connection function to avoid the misleading interpretation.