diff options
| author | Loïc Hoguin <[email protected]> | 2014-03-26 19:05:59 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2014-03-26 19:05:59 +0100 |
| commit | 17af50812c47f5dec7e02e443c551b9697715729 (patch) | |
| tree | 40684eb74e67302078f4552fab0bbd1a9dbe2d01 /src/cowboy_websocket.erl | |
| parent | 9110ee83fe47e4c41b6c001b9ae401979f8ebe4c (diff) | |
| download | cowboy-17af50812c47f5dec7e02e443c551b9697715729.tar.gz cowboy-17af50812c47f5dec7e02e443c551b9697715729.tar.bz2 cowboy-17af50812c47f5dec7e02e443c551b9697715729.zip | |
Remove outdated comments, all edoc, plus a few minor tweaks
Diffstat (limited to 'src/cowboy_websocket.erl')
| -rw-r--r-- | src/cowboy_websocket.erl | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/src/cowboy_websocket.erl b/src/cowboy_websocket.erl index 528e146..98e25e6 100644 --- a/src/cowboy_websocket.erl +++ b/src/cowboy_websocket.erl @@ -12,8 +12,6 @@ %% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -%% @doc Websocket protocol implementation. -%% %% Cowboy supports versions 7 through 17 of the Websocket drafts. %% It also supports RFC6455, the proposed standard for Websocket. -module(cowboy_websocket). @@ -23,10 +21,7 @@ %% @todo Remove when we support only R16B+. -compile(nowarn_deprecated_function). -%% API. -export([upgrade/4]). - -%% Internal. -export([handler_loop/4]). -type close_code() :: 1000..4999. @@ -62,11 +57,6 @@ deflate_state :: undefined | port() }). -%% @doc Upgrade an HTTP request to the Websocket protocol. -%% -%% You do not need to call this function manually. To upgrade to the Websocket -%% protocol, you simply need to return <em>{upgrade, protocol, {@module}}</em> -%% in your <em>cowboy_http_handler:init/3</em> handler function. -spec upgrade(Req, Env, module(), any()) -> {ok, Req, Env} | {error, 400, Req} | {suspend, module(), atom(), [any()]} @@ -215,7 +205,6 @@ handler_loop_timeout(State=#state{timeout=Timeout, timeout_ref=PrevRef}) -> TRef = erlang:start_timer(Timeout, self(), ?MODULE), State#state{timeout_ref=TRef}. -%% @private -spec handler_loop(#state{}, Req, any(), binary()) -> {ok, Req, cowboy_middleware:env()} | {suspend, module(), atom(), [any()]} |