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.await_body/index.html | 156 +++++++---------------- 1 file changed, 46 insertions(+), 110 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun.await_body/index.html') diff --git a/docs/en/gun/1.0/manual/gun.await_body/index.html b/docs/en/gun/1.0/manual/gun.await_body/index.html index 56a94dbc..a3759bed 100644 --- a/docs/en/gun/1.0/manual/gun.await_body/index.html +++ b/docs/en/gun/1.0/manual/gun.await_body/index.html @@ -62,134 +62,70 @@

gun:await_body(3)

-

Name

-
-

gun:await_body - Wait for the complete response body

-
-
-
+

gun:await_body - Wait for the complete response body

Description

-
-
-
-
await_body(ConnPid, StreamRef)
-    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
-
-await_body(ConnPid, StreamRef, MonitorRef)
-    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
-
-await_body(ConnPid, StreamRef, Timeout)
-    -> await_body(ConnPid, StreamRef, Timeout, MonitorRef)
-
-await_body(ConnPid, StreamRef, Timeout, MonitorRef)
-    -> {ok, Body} | {ok, Body, Trailers} | {error, Reason}
-
-ConnPid    :: pid()
-StreamRef  :: reference()
-MonitorRef :: reference()
-Timeout    :: timeout()
-Body       :: binary()
-Trailers   :: [{binary(), binary()}]
-Reason     :: timeout | any()
-

Wait for the complete response body.

-
-
-
+
await_body(ConnPid, StreamRef)
+    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
+
+await_body(ConnPid, StreamRef, MonitorRef)
+    -> await_body(ConnPid, StreamRef, 5000, MonitorRef)
+
+await_body(ConnPid, StreamRef, Timeout)
+    -> await_body(ConnPid, StreamRef, Timeout, MonitorRef)
+
+await_body(ConnPid, StreamRef, Timeout, MonitorRef)
+    -> {ok, Body} | {ok, Body, Trailers} | {error, Reason}
+
+ConnPid    :: pid()
+StreamRef  :: reference()
+MonitorRef :: reference()
+Timeout    :: timeout()
+Body       :: binary()
+Trailers   :: [{binary(), binary()}]
+Reason     :: timeout | any()
+
+

Wait for the complete response body.

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.

-
-Timeout -
-
-

-How long to wait for each message, in milliseconds. -

+
Timeout
+

How long to wait for each message, in milliseconds.

-
-MonitorRef -
-
-

-Monitor for the Gun connection process. -

-

A monitor is automatically created for the duration of this -call when one is not provided.

+
MonitorRef
+

Monitor for the Gun connection process.

+

A monitor is automatically created for the duration of this call when one is not provided.

-
-
- -
+

Return value

-
-

The body is returned, possibly with trailers if the -request contained a te: trailers header. Error tuples -may also be returned when a timeout or an error occur.

-
-
-
+

The body is returned, possibly with trailers if the request contained a te: trailers header. Error tuples may also be returned when a timeout or an error occur.

Changelog

-
-
    -
  • -

    -1.0: Function introduced. -

    +
    • 1.0: Function introduced.
      • -
-
-
-
+

Examples

-
-
-
Wait for the complete response body
-
-
StreamRef = gun:get(ConnPid, "/articles", [
-    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
-]).
-{response, nofin, 200, _Headers} = gun:await(ConnPid, StreamRef).
-{ok, _Body} = gun:await_body(ConnPid, StreamRef).
-
-
-
+
StreamRef = gun:get(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
+{response, nofin, 200, _Headers} = gun:await(ConnPid, StreamRef).
+{ok, _Body} = gun:await_body(ConnPid, StreamRef).
+

See also

-
-

gun(3), -gun:get(3), -gun:head(3), -gun:options(3), -gun:patch(3), -gun:post(3), -gun:put(3), -gun:delete(3), -gun:request(3), -gun:await(3)

-
- +

gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:request(3), gun:await(3)

+ -- cgit v1.2.3