diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/guide/book.asciidoc | 2 | ||||
-rw-r--r-- | doc/src/guide/migrating_from_1.2.asciidoc | 39 | ||||
-rw-r--r-- | doc/src/manual/gun.asciidoc | 2 | ||||
-rw-r--r-- | doc/src/manual/gun.info.asciidoc | 19 |
4 files changed, 60 insertions, 2 deletions
diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc index 821401b..b374c7a 100644 --- a/doc/src/guide/book.asciidoc +++ b/doc/src/guide/book.asciidoc @@ -20,6 +20,8 @@ include::websocket.asciidoc[Using Websocket] = Additional information +include::migrating_from_1.2.asciidoc[Migrating from Gun 1.2 to 1.3] + include::migrating_from_1.1.asciidoc[Migrating from Gun 1.1 to 1.2] include::migrating_from_1.0.asciidoc[Migrating from Gun 1.0 to 1.1] diff --git a/doc/src/guide/migrating_from_1.2.asciidoc b/doc/src/guide/migrating_from_1.2.asciidoc new file mode 100644 index 0000000..a870858 --- /dev/null +++ b/doc/src/guide/migrating_from_1.2.asciidoc @@ -0,0 +1,39 @@ +[appendix] +== Migrating from Gun 1.2 to 1.3 + +Gun 1.3 improves the support for CONNECT requests +introduced in the previous version and documents +Websocket protocol negotiation. + +== Features added + +* The `protocols` CONNECT destination option has been added + as a replacement for the now deprecated `protocol` option. + +* Add built-in support for Websocket protocol negotiation + through the Websocket option `protocols`. The interface + of the handler module currently remains undocumented and + must be set to `gun_ws_h`. + +* Add the h2specd HTTP/2 test suite from the h2spec project. + +=== Bugs fixed + +* Fix connecting to HTTP/2 over TLS origin servers via + HTTP/1.1 CONNECT proxies. + +* Do not send the HTTP/1.1 keepalive while waiting for + a response to a CONNECT request. + +* Do not crash on HTTP/2 HEADERS frames with the + PRIORITY flag set. + +* Do not crash on HTTP/2 HEADERS frames when the + END_HEADERS flag is not set. + +* Do not crash on unknown HTTP/2 frame types. + +* Reject HTTP/2 WINDOW_UPDATE frames when they would + cause the window to overflow. + +* Send a GOAWAY frame on closing the HTTP/2 connection. diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc index 020c8b3..a210635 100644 --- a/doc/src/manual/gun.asciidoc +++ b/doc/src/manual/gun.asciidoc @@ -313,6 +313,8 @@ undocumented and must be set to `gun_ws_h`. == Changelog +* *1.3*: Add the CONNECT destination's `protocols` option and + deprecate the previously introduced `protocol` option. * *1.2*: Introduce the type `connect_destination()`. == See also diff --git a/doc/src/manual/gun.info.asciidoc b/doc/src/manual/gun.info.asciidoc index ca7e47a..afb2333 100644 --- a/doc/src/manual/gun.info.asciidoc +++ b/doc/src/manual/gun.info.asciidoc @@ -12,8 +12,21 @@ info(ConnPid) -> Info ConnPid :: pid() Info :: #{ - sock_ip => inet:ip_address(), - sock_port => inet:port_number() + socket => inet:socket() | ssl:sslsocket(), + transport => tcp | tls, + protocol => http | http2 | ws, + sock_ip => inet:ip_address(), + sock_port => inet:port_number(), + origin_host => inet:hostname() | inet:ip_address(), + origin_port => inet:port_number(), + intermediaries => [Intermediary] +} +Intermediary :: #{ + type => connect, + host => inet:hostname() | inet:ip_address(), + port => inet:port_number(), + transport => tcp | tls, + protocol => http | http2 } ---- @@ -32,6 +45,8 @@ the connection. == Changelog +* *1.3*: The values `socket`, `transport`, `protocol`, `origin_host`, + `origin_port` and `intermediaries` were added. * *1.0*: Function introduced. == Examples |