From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/gun/1.0/manual/gun.data/index.html | 130 ++++++++--------------------- 1 file changed, 35 insertions(+), 95 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun.data') diff --git a/docs/en/gun/1.0/manual/gun.data/index.html b/docs/en/gun/1.0/manual/gun.data/index.html index 8382616e..97b689bd 100644 --- a/docs/en/gun/1.0/manual/gun.data/index.html +++ b/docs/en/gun/1.0/manual/gun.data/index.html @@ -62,119 +62,59 @@

gun:data(3)

-

Name

-
-

gun:data - Stream the body of a request

-
-
-
+

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.

-
-
-
+
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. -

+
ConnPid
+

The pid of the Gun connection process.

-
-StreamRef -
-
-

-Identifier of the stream for the original request. -

+
StreamRef
+

Identifier of the stream for the original request.

-
-IsFin -
-
-

-Whether this message terminates the request. -

+
IsFin
+

Whether this message terminates the request.

-
-Data -
-
-

-All or part of the response body. -

+
Data
+

All or part of the response body.

-
-
- -
+

Return value

-
-

The atom ok is returned.

-
-
-
+

The atom ok is returned.

Changelog

-
-
    -
  • -

    -1.0: Function introduced. -

    +
    • 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">>).
-
-
-
+
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(3), gun:patch(3), gun:post(3), gun:put(3), gun:request(3)

+ -- cgit v1.2.3