aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorViktor Söderqvist <[email protected]>2024-05-14 11:59:03 +0200
committerLoïc Hoguin <[email protected]>2025-02-27 14:23:08 +0100
commitb8940d741b0d9235cc0a610efc60746ae0e09bf3 (patch)
tree287eaffaef1de44612af002d8f6c061039157cc0 /doc/src
parent7434a10235bfa4b269230cccad12c8728bf6164f (diff)
downloadgun-b8940d741b0d9235cc0a610efc60746ae0e09bf3.tar.gz
gun-b8940d741b0d9235cc0a610efc60746ae0e09bf3.tar.bz2
gun-b8940d741b0d9235cc0a610efc60746ae0e09bf3.zip
Include event handler state in gun:info/1 result
Adds event_handler and event_handler_state in the map returned by gun:info/1. Signed-off-by: Viktor Söderqvist <[email protected]>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/manual/gun.info.asciidoc29
1 files changed, 16 insertions, 13 deletions
diff --git a/doc/src/manual/gun.info.asciidoc b/doc/src/manual/gun.info.asciidoc
index fe81e0e..6a0ffe7 100644
--- a/doc/src/manual/gun.info.asciidoc
+++ b/doc/src/manual/gun.info.asciidoc
@@ -12,18 +12,20 @@ info(ConnPid) -> Info
ConnPid :: pid()
Info :: #{
- owner => pid(),
- socket => inet:socket() | ssl:sslsocket(),
- transport => tcp | tls,
- protocol => http | http2 | socks | ws,
- sock_ip => inet:ip_address(),
- sock_port => inet:port_number(),
- origin_scheme => binary() | undefined,
- origin_host => inet:hostname() | inet:ip_address(),
- origin_port => inet:port_number(),
- intermediaries => [Intermediary],
- cookie_store => gun_cookies:cookie_store(),
- state_name => atom()
+ owner => pid(),
+ socket => inet:socket() | ssl:sslsocket(),
+ transport => tcp | tls,
+ protocol => http | http2 | socks | ws,
+ state_name => atom(),
+ sock_ip => inet:ip_address(),
+ sock_port => inet:port_number(),
+ origin_scheme => binary() | undefined,
+ origin_host => inet:hostname() | inet:ip_address(),
+ origin_port => inet:port_number(),
+ intermediaries => [Intermediary],
+ cookie_store => gun_cookies:cookie_store(),
+ event_handler => module(),
+ event_handler_state => any()
}
Intermediary :: #{
type => connect | socks5,
@@ -49,7 +51,8 @@ the connection.
== Changelog
-* *2.2*: The value `state_name` was added.
+* *2.2*: The values `event_handler`, `event_handler_state` and
+ `state_name` were added.
* *2.0*: The values `owner`, `origin_scheme` and `cookie_store` were
added.
* *1.3*: The values `socket`, `transport`, `protocol`, `origin_host`,