aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2020-11-12 11:46:53 +0100
committerLoïc Hoguin <[email protected]>2020-11-12 11:46:53 +0100
commit52ec0b5b9f297c8dfca9160dfd344abf08a4850c (patch)
treec252f06fd281dc9a7ac5011470667c7c547fa719 /doc
parent01eb4636f7a25ccdd3099629cb0d580ee8688dcc (diff)
downloadgun-52ec0b5b9f297c8dfca9160dfd344abf08a4850c.tar.gz
gun-52ec0b5b9f297c8dfca9160dfd344abf08a4850c.tar.bz2
gun-52ec0b5b9f297c8dfca9160dfd344abf08a4850c.zip
Add more new keys to gun:info and gun:stream_info manuals
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun.info.asciidoc6
-rw-r--r--doc/src/manual/gun.stream_info.asciidoc22
2 files changed, 23 insertions, 5 deletions
diff --git a/doc/src/manual/gun.info.asciidoc b/doc/src/manual/gun.info.asciidoc
index 095492e..e3c19d3 100644
--- a/doc/src/manual/gun.info.asciidoc
+++ b/doc/src/manual/gun.info.asciidoc
@@ -18,6 +18,7 @@ Info :: #{
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],
@@ -28,7 +29,7 @@ Intermediary :: #{
host => inet:hostname() | inet:ip_address(),
port => inet:port_number(),
transport => tcp | tls,
- protocol => http | http2 | socks
+ protocol => http | http2 | socks | raw
}
----
@@ -47,7 +48,8 @@ the connection.
== Changelog
-* *2.0*: The values `owner` and `cookie_store` were added.
+* *2.0*: The values `owner`, `origin_scheme` and `cookie_store` were
+ added.
* *1.3*: The values `socket`, `transport`, `protocol`, `origin_host`,
`origin_port` and `intermediaries` were added.
* *1.0*: Function introduced.
diff --git a/doc/src/manual/gun.stream_info.asciidoc b/doc/src/manual/gun.stream_info.asciidoc
index 34817fa..26ec8e2 100644
--- a/doc/src/manual/gun.stream_info.asciidoc
+++ b/doc/src/manual/gun.stream_info.asciidoc
@@ -13,9 +13,25 @@ stream_info(ConnPid, StreamRef) -> {ok, undefined | Info} | {error, not_connecte
ConnPid :: pid()
StreamRef :: gun:stream_ref()
Info :: #{
- ref => gun:stream_ref(),
- reply_to => pid(),
- state => running | stopping
+ ref => gun:stream_ref(),
+ reply_to => pid(),
+ state => running | stopping,
+ intermediaries => [Intermediary],
+ tunnel => Tunnel
+}
+Intermediary :: #{
+ type => connect | socks5,
+ host => inet:hostname() | inet:ip_address(),
+ port => inet:port_number(),
+ transport => tcp | tls,
+ protocol => http | http2 | socks | raw
+}
+Tunnel :: #{
+ transport => tcp | tls,
+ protocol => http | http2 | socks | raw,
+ origin_scheme => binary(),
+ origin_host => inet:hostname() | inet:ip_address(),
+ origin_port => inet:port_number()
}
----