0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00

Update the edoc for cowboy_ssl_transport:listen/1

This commit is contained in:
Ali Sabil 2012-03-23 07:32:44 +01:00
parent 9ac784df3b
commit 0c2cb207b9

View file

@ -48,13 +48,16 @@ messages() -> {ssl, ssl_closed, ssl_error}.
%% by default.</dd> %% by default.</dd>
%% <dt>certfile</dt><dd>Mandatory. Path to a file containing the user's %% <dt>certfile</dt><dd>Mandatory. Path to a file containing the user's
%% certificate.</dd> %% certificate.</dd>
%% <dt>keyfile</dt><dd>Mandatory. Path to the file containing the user's %% <dt>keyfile</dt><dd>Optional. Path to the file containing the user's
%% private PEM encoded key.</dd> %% private PEM encoded key.</dd>
%% <dt>cacertfile</dt><dd>Optional. Path to file containing PEM encoded %% <dt>cacertfile</dt><dd>Optional. Path to file containing PEM encoded
%% CA certificates (trusted certificates used for verifying a peer %% CA certificates (trusted certificates used for verifying a peer
%% certificate).</dd> %% certificate).</dd>
%% <dt>password</dt><dd>Mandatory. String containing the user's password. %% <dt>password</dt><dd>Optional. String containing the user's password.
%% All private keyfiles must be password protected currently.</dd> %% All private keyfiles must be password protected currently.</dd>
%% <dt>ciphers</dt><dd>Optional. The cipher suites that should be supported.
%% The function ssl:cipher_suites/0 can be used to find all available
%% ciphers.</dd>
%% </dl> %% </dl>
%% %%
%% @see ssl:listen/2 %% @see ssl:listen/2
@ -74,8 +77,8 @@ listen(Opts) ->
ListenOpts = lists:foldl(fun ListenOpts = lists:foldl(fun
({ip, _} = Ip, Acc) -> [Ip | Acc]; ({ip, _} = Ip, Acc) -> [Ip | Acc];
({keyfile, _} = KeyFile, Acc) -> [KeyFile | Acc]; ({keyfile, _} = KeyFile, Acc) -> [KeyFile | Acc];
({password, _} = Password, Acc) -> [Password | Acc];
({cacertfile, _} = CACertFile, Acc) -> [CACertFile | Acc]; ({cacertfile, _} = CACertFile, Acc) -> [CACertFile | Acc];
({password, _} = Password, Acc) -> [Password | Acc];
({ciphers, _} = Ciphers, Acc) -> [Ciphers | Acc]; ({ciphers, _} = Ciphers, Acc) -> [Ciphers | Acc];
(_, Acc) -> Acc (_, Acc) -> Acc
end, ListenOpts0, Opts), end, ListenOpts0, Opts),