From 2b588340af501825f3ab03f2e76dba0353c98fae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Jun 2018 12:59:26 +0200 Subject: Update documentation for Gun 1.0 --- docs/en/gun/1.0/manual/gun.data/index.html | 245 +++++++++++++++++++++++++++++ 1 file changed, 245 insertions(+) create mode 100644 docs/en/gun/1.0/manual/gun.data/index.html (limited to 'docs/en/gun/1.0/manual/gun.data/index.html') diff --git a/docs/en/gun/1.0/manual/gun.data/index.html b/docs/en/gun/1.0/manual/gun.data/index.html new file mode 100644 index 00000000..8382616e --- /dev/null +++ b/docs/en/gun/1.0/manual/gun.data/index.html @@ -0,0 +1,245 @@ + + + + + + + + + + Nine Nines: gun:data(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

gun:data(3)

+ +
+

Name

+
+

gun:data - Stream the body of a request

+
+
+
+

Description

+
+
+
+
data(ConnPid, StreamRef, IsFin, Data) -> ok
+
+ConnPid   :: pid()
+StreamRef :: reference()
+IsFin     :: fin | nofin
+Data      :: iodata()
+

Stream the body of a request.

+

This function can only be used if the original request +had headers indicating that a body would be streamed.

+

All calls to this function must use the nofin flag +except for the last which must use fin to indicate +the end of the request body.

+

Empty data is allowed regardless of the value of IsFin. +Gun may or may not send empty data chunks, however.

+
+
+
+

Arguments

+
+
+
+ConnPid +
+
+

+The pid of the Gun connection process. +

+
+
+StreamRef +
+
+

+Identifier of the stream for the original request. +

+
+
+IsFin +
+
+

+Whether this message terminates the request. +

+
+
+Data +
+
+

+All or part of the response body. +

+
+
+
+
+
+

Return value

+
+

The atom ok is returned.

+
+
+
+

Changelog

+
+
    +
  • +

    +1.0: Function introduced. +

    +
    • +
+
+
+
+

Examples

+
+
+
Stream the body of a request
+
+
StreamRef = gun:put(ConnPid, "/lang/fr_FR/hello", [
+    {<<"content-type">>, <<"text/plain">>}
+]).
+gun:data(ConnPid, StreamRef, nofin, <<"Bonjour !\n">>).
+gun:data(ConnPid, StreamRef, fin, <<"Bonsoir !\n">>).
+
+
+
+

See also

+
+

gun(3), +gun:patch(3), +gun:post(3), +gun:put(3), +gun:request(3)

+
+
+ + + + + +
+ +
+ + +

+ Gun + 1.0 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 1.0
    • + +
+ +
+
+
+
+ + + + + + + + + -- cgit v1.2.3