Skip to content

Commit f5a5b16

Browse files
authored
Document there is no backpressure on HTTP2
Closes #282.
1 parent 047a417 commit f5a5b16

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

lib/finch.ex

+18
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,15 @@ defmodule Finch do
328328
329329
See also `stream_while/5`.
330330
331+
> ### HTTP2 streaming and back-pressure {: .warning}
332+
>
333+
> At the moment, streaming over HTTP2 connections do not provide
334+
> any back-pressure mechanism: this means the response will be
335+
> sent to the client as quickly as possible. Therefore, you must
336+
> not use streaming over HTTP2 for non-terminating responses or
337+
> when streaming large responses which you do not intend to keep
338+
> in memory.
339+
331340
## Stream commands
332341
333342
* `{:status, status}` - the http response status
@@ -384,6 +393,15 @@ defmodule Finch do
384393
385394
See also `stream/5`.
386395
396+
> ### HTTP2 streaming and back-pressure {: .warning}
397+
>
398+
> At the moment, streaming over HTTP2 connections do not provide
399+
> any back-pressure mechanism: this means the response will be
400+
> sent to the client as quickly as possible. Therefore, you must
401+
> not use streaming over HTTP2 for non-terminating responses or
402+
> when streaming large responses which you do not intend to keep
403+
> in memory.
404+
387405
## Stream commands
388406
389407
* `{:status, status}` - the http response status

0 commit comments

Comments
 (0)