diff options
author | Loïc Hoguin <[email protected]> | 2012-08-27 11:50:35 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2012-08-27 11:50:35 +0200 |
commit | e4124de2c71564d37b3732ede0fe1542de1d6f99 (patch) | |
tree | 0e632d9eb44c848bfc4b9190251e7c8566c8debc /src/cowboy_protocol.erl | |
parent | 50e5a616dcaa765f0c795f565d361196823ed2fe (diff) | |
download | cowboy-e4124de2c71564d37b3732ede0fe1542de1d6f99.tar.gz cowboy-e4124de2c71564d37b3732ede0fe1542de1d6f99.tar.bz2 cowboy-e4124de2c71564d37b3732ede0fe1542de1d6f99.zip |
Switch to Ranch for connection handling
This is the first of many API incompatible changes.
You have been warned.
Diffstat (limited to 'src/cowboy_protocol.erl')
-rw-r--r-- | src/cowboy_protocol.erl | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/src/cowboy_protocol.erl b/src/cowboy_protocol.erl deleted file mode 100644 index 9d4f263..0000000 --- a/src/cowboy_protocol.erl +++ /dev/null @@ -1,61 +0,0 @@ -%% Copyright (c) 2011-2012, Loïc Hoguin <[email protected]> -%% Copyright (c) 2011, Michiel Hakvoort <[email protected]> -%% -%% Permission to use, copy, modify, and/or distribute this software for any -%% purpose with or without fee is hereby granted, provided that the above -%% copyright notice and this permission notice appear in all copies. -%% -%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - -%% @doc Cowboy protocol. -%% -%% A Cowboy protocol must implement one callback: <em>start_link/4</em>. -%% -%% <em>start_link/4</em> is meant for the initialization of the -%% protocol process. -%% It receives the pid to the listener's gen_server, the client socket, -%% the module name of the chosen transport and the options defined when -%% starting the listener. The <em>start_link/4</em> function must follow -%% the supervisor start function specification. -%% -%% After initializing your protocol, it is recommended to call the -%% function cowboy:accept_ack/1 with the ListenerPid as argument, -%% as it will ensure Cowboy has been able to fully initialize the socket. -%% Anything you do past this point is up to you! -%% -%% If you need to change some socket options, like enabling raw mode -%% for example, you can call the <em>Transport:setopts/2</em> function. -%% It is the protocol's responsability to manage the socket usage, -%% there should be no need for an user to specify that kind of options -%% while starting a listener. -%% -%% You should definitely look at the cowboy_http_protocol module for -%% a great example of fast request handling if you need to. -%% Otherwise it's probably safe to use <code>{active, once}</code> mode -%% and handle everything as it comes. -%% -%% Note that while you technically can run a protocol handler directly -%% as a gen_server or a gen_fsm, it's probably not a good idea, -%% as the only call you'll ever receive from Cowboy is the -%% <em>start_link/4</em> call. On the other hand, feel free to write -%% a very basic protocol handler which then forwards requests to a -%% gen_server or gen_fsm. By doing so however you must take care to -%% supervise their processes as Cowboy only knows about the protocol -%% handler itself. --module(cowboy_protocol). - --export([behaviour_info/1]). - -%% @private --spec behaviour_info(_) - -> undefined | [{start_link, 4}, ...]. -behaviour_info(callbacks) -> - [{start_link, 4}]; -behaviour_info(_Other) -> - undefined. |