aboutsummaryrefslogblamecommitdiffstats
path: root/doc/src/manual/gun.close.asciidoc
blob: cdbe05f9e947bd4d8313851645453d29e16a46a7 (plain) (tree)










































                                         

                                            
= 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)],
link:man:gun:shutdown(3)[gun:shutdown(3)]