diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/cowboy_protocol.erl | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/cowboy_protocol.erl b/src/cowboy_protocol.erl index 4d2480a..9dc35d9 100644 --- a/src/cowboy_protocol.erl +++ b/src/cowboy_protocol.erl @@ -17,32 +17,32 @@ %% %% A Cowboy protocol must implement one callback: <em>start_link/4</em>. %% -%% <em>start_link/4</em> is meant for the initialization of the +%% <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 +%% 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 wait to %% receive a message containing the atom 'shoot', as it will ensure -%% Cowboy has been able to fully initialize the socket. +%% 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, +%% 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. +%% 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 +%% 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 |