aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-04-10 12:42:39 +0300
committerLoïc Hoguin <[email protected]>2015-04-10 12:42:39 +0300
commit6676a982ff18d6a6b346f608e7ce313cfccc873e (patch)
treee0103b85fcbea53af3ea5844cd09e98c2f0f8570 /doc
parent3c051509d6b211dc4b369ba716b08d24135f29f2 (diff)
downloadgun-6676a982ff18d6a6b346f608e7ce313cfccc873e.tar.gz
gun-6676a982ff18d6a6b346f608e7ce313cfccc873e.tar.bz2
gun-6676a982ff18d6a6b346f608e7ce313cfccc873e.zip
Add functions await_up/{1,2,3} for sync open
Diffstat (limited to 'doc')
-rw-r--r--doc/src/guide/connect.asciidoc15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/src/guide/connect.asciidoc b/doc/src/guide/connect.asciidoc
index 8de8184..f734680 100644
--- a/doc/src/guide/connect.asciidoc
+++ b/doc/src/guide/connect.asciidoc
@@ -52,12 +52,25 @@ form of a map.
[source,erlang]
{ok, ConnPid} = gun:open("example.org", 8443, #{transport=>ssl}).
-=== Connection up and down messages
+=== Waiting for the connection to be established
When Gun successfully connects to the server, it sends a
`gun_up` message with the protocol that has been selected
for the connection.
+Gun provides the functions `gun:await_up/{1,2,3}` that wait
+for the `gun_up` message. They can optionally take a monitor
+reference and/or timeout value. If no monitor is provided,
+one will be created for the duration of the function call.
+
+.Synchronous opening of a connection
+
+[source,erlang]
+{ok, ConnPid} = gun:open("example.org", 443),
+{ok, Protocol} = gun:await_up(ConnPid).
+
+=== Handling connection loss
+
When the connection is lost, Gun will send a `gun_down`
message indicating the current protocol, the reason the
connection was lost and two list of stream references.