diff options
author | Loïc Hoguin <[email protected]> | 2018-06-02 22:44:16 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-06-02 22:44:16 +0200 |
commit | 5b810c924da242632a04a2c44772cb892aa1b7c0 (patch) | |
tree | e9ee81bd3b6aea1f9665914b8858edad377c24c7 /doc/src/manual/gun_data.asciidoc | |
parent | 04b41c3cf70aba88c1dd76e4e86c39458d817219 (diff) | |
download | gun-5b810c924da242632a04a2c44772cb892aa1b7c0.tar.gz gun-5b810c924da242632a04a2c44772cb892aa1b7c0.tar.bz2 gun-5b810c924da242632a04a2c44772cb892aa1b7c0.zip |
Revamp the manual, one page per function/message
Diffstat (limited to 'doc/src/manual/gun_data.asciidoc')
-rw-r--r-- | doc/src/manual/gun_data.asciidoc | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/src/manual/gun_data.asciidoc b/doc/src/manual/gun_data.asciidoc new file mode 100644 index 0000000..0176707 --- /dev/null +++ b/doc/src/manual/gun_data.asciidoc @@ -0,0 +1,77 @@ += gun_data(3) + +== Name + +gun_data - Response body + +== Description + +[source,erlang] +---- +{gun_data, ConnPid, StreamRef, IsFin, Data} + +ConnPid :: pid() +StreamRef :: reference() +IsFin :: fin | nofin +Data :: binary() +---- + +Response body. + +This message informs the relevant process that the server +sent a all or part of the body for the response to the +original request. + +A data message is always preceded by a response message. + +The response body may be terminated either by a data +message with the flag `fin` set or by a +link:man:gun_trailers(3)[gun_trailers(3)] message. + +== Elements + +ConnPid:: + +The pid of the Gun connection process. + +StreamRef:: + +Identifier of the stream for the original request. + +IsFin:: + +Whether this message terminates the response. + +Data:: + +All or part of the response body. + +== Changelog + +* *1.0*: Message introduced. + +== Examples + +.Receive a gun_data message in a gen_server +[source,erlang] +---- +handle_info({gun_data, ConnPid, _StreamRef, + _IsFin, _Data}, + State=#state{conn_pid=ConnPid}) -> + %% Do something. + {noreply, State}. +---- + +== 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: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:options(3)[gun:options(3)], +link:man:gun:request(3)[gun:request(3)], +link:man:gun_response(3)[gun_response(3)], +link:man:gun_trailers(3)[gun_trailers(3)] |