diff options
| author | Loïc Hoguin <[email protected]> | 2011-07-06 17:42:20 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2011-07-06 17:42:20 +0200 |
| commit | 108a491f5515fdc2a7fe3ce8c310a261d6be3230 (patch) | |
| tree | 74fb2109c6b193c382a0712a053702b3ec240a13 /src/cowboy_http_websocket.erl | |
| parent | 2b3bfdd783915b263ed3fdfd6e135b9a84982821 (diff) | |
| download | cowboy-108a491f5515fdc2a7fe3ce8c310a261d6be3230.tar.gz cowboy-108a491f5515fdc2a7fe3ce8c310a261d6be3230.tar.bz2 cowboy-108a491f5515fdc2a7fe3ce8c310a261d6be3230.zip | |
Add documentation for the public interface.
This is probably not perfect yet but it should be better than
nothing. We'll improve things with feedback received from the
many users.
Diffstat (limited to 'src/cowboy_http_websocket.erl')
| -rw-r--r-- | src/cowboy_http_websocket.erl | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/cowboy_http_websocket.erl b/src/cowboy_http_websocket.erl index 8463ff5..da1622c 100644 --- a/src/cowboy_http_websocket.erl +++ b/src/cowboy_http_websocket.erl @@ -12,7 +12,17 @@ %% 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 draft hixie-76 implementation. +%% +%% Known to work with the following browsers: +%% <ul> +%% <li>Mozilla Firefox 4.0 (disabled by default)</li> +%% <li>Google Chrome 6+</li> +%% <li>Safari 5.0.1+</li> +%% <li>Opera 11.00+ (disabled by default)</li> +%% </ul> -module(cowboy_http_websocket). + -export([upgrade/3]). %% API. -export([handler_loop/4]). %% Internal. @@ -30,6 +40,11 @@ hibernate = false :: boolean() }). +%% @doc Upgrade a 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(module(), any(), #http_req{}) -> ok. upgrade(Handler, Opts, Req) -> EOP = binary:compile_pattern(<< 255 >>), @@ -128,6 +143,7 @@ handler_before_loop(State, Req=#http_req{socket=Socket, transport=Transport}, Transport:setopts(Socket, [{active, once}]), handler_loop(State, Req, HandlerState, SoFar). +%% @private -spec handler_loop(#state{}, #http_req{}, any(), binary()) -> ok. handler_loop(State=#state{messages={OK, Closed, Error}, timeout=Timeout}, Req=#http_req{socket=Socket}, HandlerState, SoFar) -> |