From 17af50812c47f5dec7e02e443c551b9697715729 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 26 Mar 2014 19:05:59 +0100 Subject: Remove outdated comments, all edoc, plus a few minor tweaks --- src/cowboy_websocket_handler.erl | 34 ---------------------------------- 1 file changed, 34 deletions(-) (limited to 'src/cowboy_websocket_handler.erl') diff --git a/src/cowboy_websocket_handler.erl b/src/cowboy_websocket_handler.erl index d6adfa5..177e5f6 100644 --- a/src/cowboy_websocket_handler.erl +++ b/src/cowboy_websocket_handler.erl @@ -12,40 +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 Handler for HTTP WebSocket requests. -%% -%% WebSocket handlers must implement five callbacks: init/3, -%% websocket_init/3, websocket_handle/3, -%% websocket_info/3 and websocket_terminate/3. -%% These callbacks will only be called if the connection is upgraded -%% to WebSocket in the HTTP handler's init/3 callback. -%% They are then called in that order, although websocket_handle/3 -%% will be called for each packet received, and websocket_info -%% for each message received. -%% -%% websocket_init/3 is meant for initialization. It receives -%% information about the transport and protocol used, along with the handler -%% options from the dispatch list. You can define a request-wide state here. -%% If you are going to want to compact the request, you should probably do it -%% here. -%% -%% websocket_handle/3 receives the data from the socket. It can reply -%% something, do nothing or close the connection. -%% -%% websocket_info/3 receives messages sent to the process. It has -%% the same reply format as websocket_handle/3 described above. Note -%% that unlike in a gen_server, when websocket_info/3 -%% replies something, it is always to the socket, not to the process that -%% originated the message. -%% -%% websocket_terminate/3 is meant for cleaning up. It also receives -%% the request and the state previously defined, along with a reason for -%% termination. -%% -%% All of websocket_init/3, websocket_handle/3 and -%% websocket_info/3 can decide to hibernate the process by adding -%% an extra element to the returned tuple, containing the atom -%% hibernate. Doing so helps save memory and improve CPU usage. -module(cowboy_websocket_handler). -type opts() :: any(). -- cgit v1.2.3