aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.info.asciidoc
blob: ca7e47a3355b39860f4be2c19d4fdbdd15382b69 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
= gun:info(3)

== Name

gun:info - Obtain information about the connection

== Description

[source,erlang]
----
info(ConnPid) -> Info

ConnPid :: pid()
Info :: #{
    sock_ip   => inet:ip_address(),
    sock_port => inet:port_number()
}
----

Obtain information about the connection.

== Arguments

ConnPid::

The pid of the Gun connection process.

== Return value

A map is returned containing various informations about
the connection.

== Changelog

* *1.0*: Function introduced.

== Examples

.Obtain information about the connection
[source,erlang]
----
Info = gun:info(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)]