diff options
author | Loïc Hoguin <[email protected]> | 2019-08-02 14:30:08 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2019-08-05 19:57:13 +0200 |
commit | 611f9a9b78cab4005892e13dffb7a2c8e44580ee (patch) | |
tree | d8d3fc407110ea12333ba122cf711326e82a7070 /doc/src/manual/gun.update_flow.asciidoc | |
parent | 145b9af4bdbb85e2f83959ee8abaa4d9207a4529 (diff) | |
download | gun-611f9a9b78cab4005892e13dffb7a2c8e44580ee.tar.gz gun-611f9a9b78cab4005892e13dffb7a2c8e44580ee.tar.bz2 gun-611f9a9b78cab4005892e13dffb7a2c8e44580ee.zip |
Add flow control
Flow control is disabled by default. The initial flow value
must be set to enable it (either for the entire connection
or on a per-request basis). Flow applies to all HTTP streams
as well as Websocket. HTTP/2 pushed streams receive the same
value as their originating stream.
Diffstat (limited to 'doc/src/manual/gun.update_flow.asciidoc')
-rw-r--r-- | doc/src/manual/gun.update_flow.asciidoc | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/src/manual/gun.update_flow.asciidoc b/doc/src/manual/gun.update_flow.asciidoc new file mode 100644 index 0000000..c7990f2 --- /dev/null +++ b/doc/src/manual/gun.update_flow.asciidoc @@ -0,0 +1,67 @@ += gun:update_flow(3) + +== Name + +gun:update_flow - Update a stream's flow control value + +== Description + +[source,erlang] +---- +update_flow(ConnPid, StreamRef, Flow) -> ok + +ConnPid :: pid() +StreamRef :: reference() +Flow :: pos_integer() +---- + +Update a stream's flow control value. + +The flow value can only ever be incremented. + +This function does nothing for streams that have flow +control disabled (which is the default). + +== Arguments + +ConnPid:: + +The pid of the Gun connection process. + +StreamRef:: + +Identifier of the stream for the original request. + +Flow:: + +Flow control value increment. + +== Return value + +The atom `ok` is returned. + +== Changelog + +* *2.0*: Function introduced. + +== Examples + +.Update a stream's flow control value +[source,erlang] +---- +gun:update_flow(ConnPid, StreamRef, 10). +---- + +== See also + +link:man:gun(3)[gun(3)], +link:man:gun:get(3)[gun:get(3)], +link:man:gun:head(3)[gun:head(3)], +link:man:gun:options(3)[gun:options(3)], +link:man:gun:patch(3)[gun:patch(3)], +link:man:gun:post(3)[gun:post(3)], +link:man:gun:put(3)[gun:put(3)], +link:man:gun:delete(3)[gun:delete(3)], +link:man:gun:headers(3)[gun:headers(3)], +link:man:gun:request(3)[gun:request(3)], +link:man:gun:ws_upgrade(3)[gun:ws_upgrade(3)] |