aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-06-07 15:15:54 +0200
committerLoïc Hoguin <[email protected]>2017-06-07 15:15:54 +0200
commit6f7b59886ec17027b16ed4d10737452e17f233d0 (patch)
tree6beec34b1f3343ab250d3993d5a0d572cbd956f5 /doc
parent767da623f1f7329cb0b0d86c3c1876ccf098d60a (diff)
downloadcowboy-6f7b59886ec17027b16ed4d10737452e17f233d0.tar.gz
cowboy-6f7b59886ec17027b16ed4d10737452e17f233d0.tar.bz2
cowboy-6f7b59886ec17027b16ed4d10737452e17f233d0.zip
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/src/guide/getting_started.asciidoc2
-rw-r--r--doc/src/guide/listeners.asciidoc4
-rw-r--r--doc/src/guide/routing.asciidoc2
-rw-r--r--doc/src/manual/cowboy.start_clear.asciidoc21
-rw-r--r--doc/src/manual/cowboy.start_tls.asciidoc21
-rw-r--r--doc/src/manual/cowboy_http.asciidoc2
-rw-r--r--doc/src/manual/cowboy_http2.asciidoc2
-rw-r--r--doc/src/manual/cowboy_router.compile.asciidoc2
8 files changed, 11 insertions, 45 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index 7fb787d..29a406b 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -99,7 +99,7 @@ start(_Type, _Args) ->
Dispatch = cowboy_router:compile([
{'_', [{"/", hello_handler, []}]}
]),
- {ok, _} = cowboy:start_clear(my_http_listener, 100,
+ {ok, _} = cowboy:start_clear(my_http_listener,
[{port, 8080}],
#{env => #{dispatch => Dispatch}}
),
diff --git a/doc/src/guide/listeners.asciidoc b/doc/src/guide/listeners.asciidoc
index 7d5faec..d905c68 100644
--- a/doc/src/guide/listeners.asciidoc
+++ b/doc/src/guide/listeners.asciidoc
@@ -31,7 +31,7 @@ start(_Type, _Args) ->
Dispatch = cowboy_router:compile([
{'_', [{"/", hello_handler, []}]}
]),
- {ok, _} = cowboy:start_clear(my_http_listener, 100,
+ {ok, _} = cowboy:start_clear(my_http_listener,
[{port, 8080}],
#{env => #{dispatch => Dispatch}}
),
@@ -75,7 +75,7 @@ start(_Type, _Args) ->
Dispatch = cowboy_router:compile([
{'_', [{"/", hello_handler, []}]}
]),
- {ok, _} = cowboy:start_tls(my_http_listener, 100,
+ {ok, _} = cowboy:start_tls(my_http_listener,
[
{port, 8443},
{certfile, "/path/to/certfile"},
diff --git a/doc/src/guide/routing.asciidoc b/doc/src/guide/routing.asciidoc
index dec089a..2d8a1f2 100644
--- a/doc/src/guide/routing.asciidoc
+++ b/doc/src/guide/routing.asciidoc
@@ -203,7 +203,7 @@ Dispatch = cowboy_router:compile([
{'_', [{'_', my_handler, #{}}]}
]),
%% Name, NbAcceptors, TransOpts, ProtoOpts
-cowboy:start_clear(my_http_listener, 100,
+cowboy:start_clear(my_http_listener,
[{port, 8080}],
#{env => #{dispatch => Dispatch}}
).
diff --git a/doc/src/manual/cowboy.start_clear.asciidoc b/doc/src/manual/cowboy.start_clear.asciidoc
index e119fc3..7a12a58 100644
--- a/doc/src/manual/cowboy.start_clear.asciidoc
+++ b/doc/src/manual/cowboy.start_clear.asciidoc
@@ -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}
}),
diff --git a/doc/src/manual/cowboy.start_tls.asciidoc b/doc/src/manual/cowboy.start_tls.asciidoc
index f5e7fb4..1cf87c9 100644
--- a/doc/src/manual/cowboy.start_tls.asciidoc
+++ b/doc/src/manual/cowboy.start_tls.asciidoc
@@ -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}
diff --git a/doc/src/manual/cowboy_http.asciidoc b/doc/src/manual/cowboy_http.asciidoc
index 45d5464..0c67d9e 100644
--- a/doc/src/manual/cowboy_http.asciidoc
+++ b/doc/src/manual/cowboy_http.asciidoc
@@ -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
diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc
index d966459..517879f 100644
--- a/doc/src/manual/cowboy_http2.asciidoc
+++ b/doc/src/manual/cowboy_http2.asciidoc
@@ -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
diff --git a/doc/src/manual/cowboy_router.compile.asciidoc b/doc/src/manual/cowboy_router.compile.asciidoc
index ab4eddc..f0b3f14 100644
--- a/doc/src/manual/cowboy_router.compile.asciidoc
+++ b/doc/src/manual/cowboy_router.compile.asciidoc
@@ -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}
}).
----