aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.close.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-02 22:44:16 +0200
committerLoïc Hoguin <[email protected]>2018-06-02 22:44:16 +0200
commit5b810c924da242632a04a2c44772cb892aa1b7c0 (patch)
treee9ee81bd3b6aea1f9665914b8858edad377c24c7 /doc/src/manual/gun.close.asciidoc
parent04b41c3cf70aba88c1dd76e4e86c39458d817219 (diff)
downloadgun-5b810c924da242632a04a2c44772cb892aa1b7c0.tar.gz
gun-5b810c924da242632a04a2c44772cb892aa1b7c0.tar.bz2
gun-5b810c924da242632a04a2c44772cb892aa1b7c0.zip
Revamp the manual, one page per function/message
Diffstat (limited to 'doc/src/manual/gun.close.asciidoc')
-rw-r--r--doc/src/manual/gun.close.asciidoc44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/src/manual/gun.close.asciidoc b/doc/src/manual/gun.close.asciidoc
new file mode 100644
index 0000000..20fd1bf
--- /dev/null
+++ b/doc/src/manual/gun.close.asciidoc
@@ -0,0 +1,44 @@
+= gun:close(3)
+
+== Name
+
+gun:close - Brutally close the connection
+
+== Description
+
+[source,erlang]
+----
+close(ConnPid) -> ok
+
+ConnPid :: pid()
+----
+
+Brutally close the connection.
+
+== Arguments
+
+ConnPid::
+
+The pid of the Gun connection process.
+
+== Return value
+
+The atom `ok` is returned.
+
+== Changelog
+
+* *1.0*: Function introduced.
+
+== Examples
+
+.Close the connection
+[source,erlang]
+----
+ok = gun:close(ConnPid).
+----
+
+== See also
+
+link:man:gun(3)[gun(3)],
+link:man:gun:open(3)[gun:open(3)],
+link:man:gun:open_unix(3)[gun:open_unix(3)]