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.

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

fix!: close streams gracefully #1868

Closed

Conversation

achingbrain
Copy link
Member

  • Refactors .close, closeRead and .closeWrite methods on the Stream interface to be async
  • The Connection interface now has .close and .abort methods
  • .close on Streams and Connections wait for the internal message queues to empty before closing
  • .abort on Streams and Connections close the underlying stream immediately and discards any unsent data
  • @chainsafe/libp2p-yamux now uses the AbstractStream class from @libp2p/interface the same as @libp2p/mplex and
    @libp2p/webrtc

Follow-up PRs will be necessary to @chainsafe/libp2p-yamux, @chainsafe/libp2p-gossipsub and @chainsafe/libp2p-noise
though they will not block the release as their code is temporarily added to this repo to let CI run.

Fixes #1793
Fixes #656

BREAKING CHANGE: the .close, closeRead and closeWrite methods on the Stream interface are now asynchronous

- Refactors `.close`, `closeRead` and `.closeWrite` methods on the `Stream` interface to be async
- The `Connection` interface now has `.close` and `.abort` methods
- `.close` on `Stream`s and `Connection`s wait for the internal message queues to empty before closing
- `.abort` on `Stream`s and `Connection`s close the underlying stream immediately and discards any unsent data
- `@chainsafe/libp2p-yamux` now uses the `AbstractStream` class from `@libp2p/interface` the same as `@libp2p/mplex` and
`@libp2p/webrtc`

Follow-up PRs will be necessary to `@chainsafe/libp2p-yamux`, `@chainsafe/libp2p-gossipsub` and `@chainsafe/libp2p-noise`
though they will not block the release as their code is temporarily added to this repo to let CI run.

Fixes #1793
Fixes #656

BREAKING CHANGE: the `.close`, `closeRead` and `closeWrite` methods on the `Stream` interface are now asynchronous
@achingbrain
Copy link
Member Author

Pushed to a different branch because for some reason GitHub isn't noticing pushes to #1864

@achingbrain
Copy link
Member Author

Closing as GitHub appears to have woken up.

@achingbrain achingbrain closed this Jul 5, 2023
@achingbrain achingbrain deleted the fix/close-streams-gracefully-ci branch July 5, 2023 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant