diff options
| author | niku <[email protected]> | 2018-04-14 01:16:29 +0900 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-05-07 13:50:12 +0200 |
| commit | ddd03ed95098d6664ed9b623d8b9b830f7e28815 (patch) | |
| tree | 1eca0cf16589e159488ff8efb2fc9ca2fb22802b | |
| parent | a00a6b2d047a5d41e8e062d1c414000b000b45d7 (diff) | |
| download | gun-ddd03ed95098d6664ed9b623d8b9b830f7e28815.tar.gz gun-ddd03ed95098d6664ed9b623d8b9b830f7e28815.tar.bz2 gun-ddd03ed95098d6664ed9b623d8b9b830f7e28815.zip | |
Fix the document about `ws_upgrade`
| -rw-r--r-- | doc/src/manual/gun.asciidoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc index 02d0b86..3332631 100644 --- a/doc/src/manual/gun.asciidoc +++ b/doc/src/manual/gun.asciidoc @@ -693,13 +693,13 @@ HTTP/2 streams can however be cancelled at any time. Alias of `gun:ws_upgrade/3`. -=== ws_upgrade(ConnPid, Path, Headers) -> ok +=== ws_upgrade(ConnPid, Path, Headers) -> ws_upgrade(ConnPid, Path, Headers, #{}) Similar to `gun:ws_upgrade/4`, except `WsOpts` is taken from the options given in the `gun:open/{2,3}` call when opening the connection. -=== ws_upgrade(ConnPid, Path, Headers, WsOpts) -> ok +=== ws_upgrade(ConnPid, Path, Headers, WsOpts) -> StreamRef ConnPid = pid():: The pid of the Gun connection process. Path = iodata():: Path to the resource. |