From 24b2e92a06cf6275b972f66373d7bfea7bfc3518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 1 Oct 2018 16:35:30 +0200 Subject: Gun 1.3.0 --- docs/en/gun/1.3/manual/gun.await_up/index.html | 194 +++++++++++++++++++++++++ 1 file changed, 194 insertions(+) create mode 100644 docs/en/gun/1.3/manual/gun.await_up/index.html (limited to 'docs/en/gun/1.3/manual/gun.await_up') diff --git a/docs/en/gun/1.3/manual/gun.await_up/index.html b/docs/en/gun/1.3/manual/gun.await_up/index.html new file mode 100644 index 00000000..489a2779 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.await_up/index.html @@ -0,0 +1,194 @@ + + + + + + + + + + Nine Nines: gun:await_up(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

gun:await_up(3)

+ +

Name

+

gun:await_up - Wait for the connection to be up

+

Description

+
+
await_up(ConnPid)
+    -> 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, MonitorRef)
+    -> {ok, Protocol} | {error, Reason}
+
+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.

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

+
+
+

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.

+

Changelog

+
  • 1.0: Function introduced. +
    • +
+

Examples

+
Wait for the connection to be up
+
+
{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 + 1.3 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3