diff options
author | Loïc Hoguin <[email protected]> | 2015-04-10 17:34:26 +0300 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2015-04-10 17:34:26 +0300 |
commit | f618634bf648124c9562aaf49ee460be9ef71ae7 (patch) | |
tree | a0bd678d5e053358d3662ee626db677ab6033b2e /doc/src/manual | |
parent | cff0a87d3cbdcf67a9049cdc2784d459711e2867 (diff) | |
download | gun-f618634bf648124c9562aaf49ee460be9ef71ae7.tar.gz gun-f618634bf648124c9562aaf49ee460be9ef71ae7.tar.bz2 gun-f618634bf648124c9562aaf49ee460be9ef71ae7.zip |
Add headers to gun_ws_upgrade message
Also improves the code and documentation about this message.
It was incorrectly specified that a gun_ws_upgrade message
could be sent on error; instead a gun_response is sent.
Diffstat (limited to 'doc/src/manual')
-rw-r--r-- | doc/src/manual/gun.asciidoc | 14 |
1 files changed, 2 insertions, 12 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc index 7c12fc3..baaadcf 100644 --- a/doc/src/manual/gun.asciidoc +++ b/doc/src/manual/gun.asciidoc @@ -194,22 +194,12 @@ Reason = any():: Error reason. General error. -=== {gun_ws_upgrade, ConnPid, ok} +=== {gun_ws_upgrade, ConnPid, ok, Headers} ConnPid = pid():: The pid of the Gun connection process. - -Successful upgrade to the Websocket protocol. - -@todo Yeah we need the headers. - -=== {gun_ws_upgrade, ConnPid, error, IsFin, Status, Headers} - -ConnPid = pid():: The pid of the Gun connection process. -IsFin = fin | nofin:: Whether this message terminates the response. -Status = binary():: Status line for the response. Headers = [{binary(), binary()}]:: Headers sent with the response. -Failed upgrade to the Websocket protocol. +Successful upgrade to the Websocket protocol. === {gun_ws, ConnPid, Frame} |