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

Remove NumAcceptors argument from start_clear/tls

They are now cowboy:start_clear/3 and cowboy:start_tls/3.
The NumAcceptors argument can be specified via the
num_acceptor transport option. Ranch has been updated
to 1.4.0 to that effect.
This commit is contained in:
Loïc Hoguin 2017-06-07 15:15:54 +02:00
parent 767da623f1
commit 6f7b59886e
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
30 changed files with 45 additions and 83 deletions

View file

@ -9,7 +9,6 @@ cowboy:start_clear - Listen for connections using plain TCP
[source,erlang]
----
start_clear(Name :: ranch:ref(),
NumAcceptors :: non_neg_integer(),
TransportOpts :: ranch_tcp:opts(),
ProtocolOpts :: opts())
-> {ok, ListenerPid :: pid()}
@ -34,22 +33,6 @@ updating the routes defined.
It can be any Erlang term. An atom is generally good enough,
for example `api`, `my_app_clear` or `my_app_tls`.
NumAcceptors::
The number of acceptors is the number of processes that
will accept connections. Tweak this value to improve the
accept rate for incoming connections.
+
The ideal value is between 10 and 100 on most systems.
Larger values may have the opposite effect and reduce the
accept rate. It's generally safe to start with a value of
100 (or 10 on low memory systems). Then, when accept rates
become a concern, measure the performance and update the
value accordingly.
+
This value is unrelated to the maximum number of concurrent
connections.
TransportOpts::
The transport options are where the TCP options, including
@ -102,7 +85,7 @@ Dispatch = cowboy_router:compile([
]}
]),
{ok, _} = cowboy:start_clear(example, 100, [{port, 8080}], #{
{ok, _} = cowboy:start_clear(example, [{port, 8080}], #{
env => #{dispatch => Dispatch}
}).
----
@ -112,7 +95,7 @@ Dispatch = cowboy_router:compile([
----
Name = example,
{ok, _} = cowboy:start_clear(Name, 100, [], #{
{ok, _} = cowboy:start_clear(Name, [], #{
env => #{dispatch => Dispatch}
}),

View file

@ -9,7 +9,6 @@ cowboy:start_tls - Listen for connections using TLS
[source,erlang]
----
start_tls(Name :: ranch:ref(),
NumAcceptors :: non_neg_integer(),
TransportOpts :: ranch_ssl:opts(),
ProtocolOpts :: opts())
-> {ok, ListenerPid :: pid()}
@ -33,22 +32,6 @@ updating the routes defined.
It can be any Erlang term. An atom is generally good enough,
for example `api`, `my_app_clear` or `my_app_tls`.
NumAcceptors::
The number of acceptors is the number of processes that
will accept connections. Tweak this value to improve the
accept rate for incoming connections.
+
The ideal value is between 10 and 100 on most systems.
Larger values may have the opposite effect and reduce the
accept rate. It's generally safe to start with a value of
100 (or 10 on low memory systems). Then, when accept rates
become a concern, measure the performance and update the
value accordingly.
+
This value is unrelated to the maximum number of concurrent
connections.
TransportOpts::
The transport options are where the TCP options, including
@ -102,7 +85,7 @@ Dispatch = cowboy_router:compile([
]}
]),
{ok, _} = cowboy:start_tls(example, 100, [
{ok, _} = cowboy:start_tls(example, [
{port, 8443},
{cert, "path/to/cert.pem"}
], #{
@ -115,7 +98,7 @@ Dispatch = cowboy_router:compile([
----
Name = example,
{ok, _} = cowboy:start_tls(Name, 100, [
{ok, _} = cowboy:start_tls(Name, [
{cert, "path/to/cert.pem"}
], #{
env => #{dispatch => Dispatch}

View file

@ -38,7 +38,7 @@ opts() :: #{
Configuration for the HTTP/1.1 protocol.
This configuration is passed to Cowboy when starting listeners
using `cowboy:start_clear/4` or `cowboy:start_tls/4` functions.
using `cowboy:start_clear/3` or `cowboy:start_tls/3` functions.
It can be updated without restarting listeners using the
Ranch functions `ranch:get_protocol_options/1` and

View file

@ -30,7 +30,7 @@ opts() :: #{
Configuration for the HTTP/2 protocol.
This configuration is passed to Cowboy when starting listeners
using `cowboy:start_clear/4` or `cowboy:start_tls/4` functions.
using `cowboy:start_clear/3` or `cowboy:start_tls/3` functions.
It can be updated without restarting listeners using the
Ranch functions `ranch:get_protocol_options/1` and

View file

@ -43,7 +43,7 @@ Dispatch = cowboy_router:compile([
]}
]),
{ok, _} = cowboy:start_clear(example, 100, [{port, 8080}], #{
{ok, _} = cowboy:start_clear(example, [{port, 8080}], #{
env => #{dispatch => Dispatch}
}).
----