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_up/index.html | 123 +++++++------------------ 1 file changed, 35 insertions(+), 88 deletions(-) (limited to 'docs/en/gun/1.0/manual/gun.await_up/index.html') diff --git a/docs/en/gun/1.0/manual/gun.await_up/index.html b/docs/en/gun/1.0/manual/gun.await_up/index.html index dc3eea5c..b437925e 100644 --- a/docs/en/gun/1.0/manual/gun.await_up/index.html +++ b/docs/en/gun/1.0/manual/gun.await_up/index.html @@ -62,115 +62,62 @@

gun:await_up(3)

-

Name

-
-

gun:await_up - Wait for the connection to be up

-
-
-
+

gun:await_up - Wait for the connection to be up

Description

-
-
-
-
await_up(ConnPid)
-    -> await_up(ConnPid, 5000, MonitorRef)
+
await_up(ConnPid)
+    -> await_up(ConnPid, 5000, MonitorRef)
 
-await_up(ConnPid, MonitorRef)
-    -> await_up(ConnPid, 5000, MonitorRef)
+await_up(ConnPid, MonitorRef)
+    -> await_up(ConnPid, 5000, MonitorRef)
 
-await_up(ConnPid, Timeout)
-    -> await_up(ConnPid, Timeout, MonitorRef)
+await_up(ConnPid, Timeout)
+    -> await_up(ConnPid, Timeout, MonitorRef)
 
-await_up(ConnPid, Timeout, MonitorRef)
-    -> {ok, Protocol} | {error, Reason}
+await_up(ConnPid, Timeout, MonitorRef)
+    -> {ok, Protocol} | {error, Reason}
 
-ConnPid    :: pid()
-MonitorRef :: reference()
-Timeout    :: timeout()
-Protocol   :: http | http2
-Reason     :: timeout | any()
-

Wait for the connection to be up.

-
-
-
+ConnPid :: pid() +MonitorRef :: reference() +Timeout :: timeout() +Protocol :: http | http2 +Reason :: timeout | any() +
+

Wait for the connection to be up.

Arguments

-
-
-
-ConnPid -
-
-

-The pid of the Gun connection process. -

+
ConnPid
+

The pid of the Gun connection process.

-
-Timeout -
-
-

-How long to wait for, in milliseconds. -

+
Timeout
+

How long to wait for, 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 protocol selected for this connection. It can be used -to determine the capabilities of the server. Error tuples -may also be returned when a timeout or an error occur.

-
-
-
+

The protocol selected for this connection. It can be used to determine the capabilities of the server. 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 connection to be up
-
-
{ok, ConnPid} = gun:open("example.org", 443).
-{ok, _} = gun:await_up(ConnPid).
-
-
-
+
{ok, ConnPid} = gun:open("example.org", 443).
+{ok, _} = gun:await_up(ConnPid).
+

See also

-
-

gun(3), -gun:open(3), -gun:open_unix(3), -gun_up(3)

-
- +

gun(3), gun:open(3), gun:open_unix(3), gun_up(3)

+ -- cgit v1.2.3