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_protocol.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_protocol.erl')
| -rw-r--r-- | src/cowboy_http_protocol.erl | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/cowboy_http_protocol.erl b/src/cowboy_http_protocol.erl index 51be028..779866a 100644 --- a/src/cowboy_http_protocol.erl +++ b/src/cowboy_http_protocol.erl @@ -13,7 +13,24 @@ %% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +%% @doc HTTP protocol handler. +%% +%% The available options are: +%% <dl> +%% <dt>dispatch</dt><dd>The dispatch list for this protocol.</dd> +%% <dt>max_empty_lines</dt><dd>Max number of empty lines before a request. +%% Defaults to 5.</dd> +%% <dt>timeout</dt><dd>Time in milliseconds before an idle keep-alive +%% connection is closed. Defaults to 5000 milliseconds.</dd> +%% </dl> +%% +%% Note that there is no need to monitor these processes when using Cowboy as +%% an application as it already supervises them under the listener supervisor. +%% +%% @see cowboy_dispatcher +%% @see cowboy_http_handler -module(cowboy_http_protocol). + -export([start_link/3]). %% API. -export([init/3, parse_request/1]). %% FSM. @@ -33,6 +50,7 @@ %% API. +%% @doc Start an HTTP protocol process. -spec start_link(inet:socket(), module(), any()) -> {ok, pid()}. start_link(Socket, Transport, Opts) -> Pid = spawn_link(?MODULE, init, [Socket, Transport, Opts]), @@ -40,6 +58,7 @@ start_link(Socket, Transport, Opts) -> %% FSM. +%% @private -spec init(inet:socket(), module(), any()) -> ok. init(Socket, Transport, Opts) -> Dispatch = proplists:get_value(dispatch, Opts, []), @@ -48,6 +67,7 @@ init(Socket, Transport, Opts) -> wait_request(#state{socket=Socket, transport=Transport, dispatch=Dispatch, max_empty_lines=MaxEmptyLines, timeout=Timeout}). +%% @private -spec parse_request(#state{}) -> ok. %% @todo Use decode_packet options to limit length? parse_request(State=#state{buffer=Buffer}) -> |