Remove the SHUTDOWNABLE signature #17
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This follows the clarification that `V1_LWT.close` follows the behaviour of the Mirage tcp/ip stack i.e. it signals a "shutdown" to the remote (like sending an `Eof`) while leaving the resources allocated and the connection up. Implementations which associate extra resources with a connection (such as a file descriptor or socket buffers) need provide some other cleanup method (e.g. a `disconnect` function) Fixes mirage#16 Signed-off-by: David Scott <dave@recoil.org>
This is a backwards-incompatible change so bump the major version. Signed-off-by: David Scott <dave@recoil.org>
Signed-off-by: David Scott <dave@recoil.org>
|
It's been rather quiet, so I'll mention that I'm in favor of this change but need to do some work on vpnkit to support it. |
|
wondering what the status hereof is? I'm always in favour of removing code, esp. if it is confusing. |
|
^ @djs55 , since I no longer do any work on vpnkit and honestly have no memory of what the state of this is 😅 |
|
ping, @djs55 any chance you can rebase this PR? |
|
integrated into #48 |
hannesm
added a commit
to hannesm/opam-repository
that referenced
this pull request
Dec 17, 2023
…rs (4.0.0) CHANGES: - Add ``shutdown : flow -> [ `read | `write | `read_write ] -> unit Lwt.t`` (@djs55 @hannesm mirage/mirage-flow#16 mirage/mirage-flow#18 mirage/mirage-flow#48) - Remove SHUTDOWNABLE signature (@djs55 mirage/mirage-flow#17, rebased into mirage/mirage-flow#48)
hannesm
added a commit
to hannesm/opam-repository
that referenced
this pull request
Dec 19, 2023
…rs (4.0.0) CHANGES: - Redefine `close` semantics, which no longer is a `` shutdown `read_write `` (mirage/mirage-flow#49 @hannesm) - Add ``shutdown : flow -> [ `read | `write | `read_write ] -> unit Lwt.t`` (@djs55 @hannesm mirage/mirage-flow#16 mirage/mirage-flow#18 mirage/mirage-flow#48) - Remove SHUTDOWNABLE signature (@djs55 mirage/mirage-flow#17, rebased into mirage/mirage-flow#48)
hannesm
added a commit
to hannesm/opam-repository
that referenced
this pull request
Dec 19, 2023
…rs (4.0.0) CHANGES: - Redefine `close` semantics, which no longer is a `` shutdown `read_write `` (mirage/mirage-flow#49 @hannesm) - Add ``shutdown : flow -> [ `read | `write | `read_write ] -> unit Lwt.t`` (@djs55 @hannesm mirage/mirage-flow#16 mirage/mirage-flow#18 mirage/mirage-flow#48) - Remove SHUTDOWNABLE signature (@djs55 mirage/mirage-flow#17, rebased into mirage/mirage-flow#48)
nberth
pushed a commit
to nberth/opam-repository
that referenced
this pull request
Jun 18, 2024
…rs (4.0.0) CHANGES: - Redefine `close` semantics, which no longer is a `` shutdown `read_write `` (mirage/mirage-flow#49 @hannesm) - Add ``shutdown : flow -> [ `read | `write | `read_write ] -> unit Lwt.t`` (@djs55 @hannesm mirage/mirage-flow#16 mirage/mirage-flow#18 mirage/mirage-flow#48) - Remove SHUTDOWNABLE signature (@djs55 mirage/mirage-flow#17, rebased into mirage/mirage-flow#48)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This was a misunderstanding over the semantics of
closewhich have been clarified upstream. Since it's a backwards-incompatible change we also bump the version to 2.0.0.This PR shouldn't be merged until the users of this signature have been ported to the vanilla
V1_LWT.FLOWsignature:mirage/ocaml-git: usesmirage-flowbut notSHUTDOWNABLEdocker/vpnkit: https://github.com/docker/vpnkit/blob/ecdded8799428fc58aa1d35f34b8dbff8cc9baf6/src/hostnet/lib/sig.ml#L2djs55/ocaml-hvsock: https://github.com/djs55/ocaml-hvsock/blob/9da157786e9bb113f0f31f00be86ffaae0b585d0/lwt/flow_lwt_hvsock_shutdown.mli#L24