Merge pull request #283 from josevalim/patch-1

sneako · Aug 5, 2024 · 59e035b · 59e035b
2 parents 047a417 + f5a5b16
commit 59e035b
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/lib/finch.ex b/lib/finch.ex
@@ -328,6 +328,15 @@ defmodule Finch do
 
   See also `stream_while/5`.
 
+  > ### HTTP2 streaming and back-pressure {: .warning}
+  >
+  > At the moment, streaming over HTTP2 connections do not provide
+  > any back-pressure mechanism: this means the response will be
+  > sent to the client as quickly as possible. Therefore, you must
+  > not use streaming over HTTP2 for non-terminating responses or
+  > when streaming large responses which you do not intend to keep
+  > in memory.
+
   ## Stream commands
 
     * `{:status, status}` - the http response status
@@ -384,6 +393,15 @@ defmodule Finch do
 
   See also `stream/5`.
 
+  > ### HTTP2 streaming and back-pressure {: .warning}
+  >
+  > At the moment, streaming over HTTP2 connections do not provide
+  > any back-pressure mechanism: this means the response will be
+  > sent to the client as quickly as possible. Therefore, you must
+  > not use streaming over HTTP2 for non-terminating responses or
+  > when streaming large responses which you do not intend to keep
+  > in memory.
+
   ## Stream commands
 
     * `{:status, status}` - the http response status