chore: deprecate WindowUpdateMode::OnReceive

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.12.1
+
+- Deprecate `WindowUpdateMode::OnReceive`.
+  It does not enforce flow-control, i.e. breaks backpressure.
+  Use `WindowUpdateMode::OnRead` instead.
+  See [PR #177](https://github.com/libp2p/rust-yamux/pull/177).
+
 # 0.12.0
 
 - Remove `Control` and `ControlledConnection`.

yamux/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yamux"
-version = "0.12.0"
+version = "0.12.1"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "Apache-2.0 OR MIT"
 description = "Multiplexer over reliable, ordered connections"
@@ -20,3 +20,4 @@ pin-project = "1.1.0"
 
 [dev-dependencies]
 quickcheck = "1.0"
+futures = { version = "0.3.12", default-features = false, features = ["executor"] }

yamux/src/connection.rs

@@ -650,6 +650,7 @@ impl<T: AsyncRead + AsyncWrite + Unpin> Active<T> {
                 shared.window = shared.window.saturating_sub(frame.body_len());
                 shared.buffer.push(frame.into_body());
 
+                #[allow(deprecated)]
                 if matches!(self.config.window_update_mode, WindowUpdateMode::OnReceive) {
                     if let Some(credit) = shared.next_window_update() {
                         shared.window += credit;
@@ -695,6 +696,7 @@ impl<T: AsyncRead + AsyncWrite + Unpin> Active<T> {
             if let Some(w) = shared.reader.take() {
                 w.wake()
             }
+            #[allow(deprecated)]
             if matches!(self.config.window_update_mode, WindowUpdateMode::OnReceive) {
                 if let Some(credit) = shared.next_window_update() {
                     shared.window += credit;

yamux/src/connection/stream.rs

@@ -202,6 +202,7 @@ impl Stream {
     fn send_window_update(&mut self, cx: &mut Context) -> Poll<io::Result<()>> {
         // When using [`WindowUpdateMode::OnReceive`] window update messages are
         // send early on data receival (see [`crate::Connection::on_frame`]).
+        #[allow(deprecated)]
         if matches!(self.config.window_update_mode, WindowUpdateMode::OnReceive) {
             return Poll::Ready(Ok(()));
         }
@@ -500,6 +501,7 @@ impl Shared {
         }
 
         let new_credit = match self.config.window_update_mode {
+            #[allow(deprecated)]
             WindowUpdateMode::OnReceive => {
                 debug_assert!(self.config.receive_window >= self.window);
 

yamux/src/lib.rs

@@ -73,20 +73,13 @@ pub enum WindowUpdateMode {
     /// data in its buffer which may reach its limit (see `set_max_buffer_size`).
     /// In this mode, window updates merely prevent head of line blocking but do not
     /// effectively exercise back pressure on senders.
+    #[deprecated(note = "Use `WindowUpdateMode::OnRead` instead.")]
     OnReceive,
 
     /// Send window updates only when data is read on the receiving end.
     ///
     /// This ensures that senders do not overwhelm receivers and keeps buffer usage
-    /// low. However, depending on the protocol, there is a risk of deadlock, namely
-    /// if both endpoints want to send data larger than the receivers window and they
-    /// do not read before finishing their writes. Use this mode only if you are sure
-    /// that this will never happen, i.e. if
-    ///
-    /// - Endpoints *A* and *B* never write at the same time, *or*
-    /// - Endpoints *A* and *B* write at most *n* frames concurrently such that the sum
-    ///   of the frame lengths is less or equal to the available credit of *A* and *B*
-    ///   respectively.
+    /// low.
     OnRead,
 }