From 6012eee1ba9f56673df16645a9e6d91ae12cdbc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 8 May 2019 18:26:51 +0200 Subject: No longer accept mix of Ranch/socket options as list --- doc/src/manual/ranch.asciidoc | 25 +--------------------- doc/src/manual/ranch.child_spec.asciidoc | 2 ++ .../manual/ranch.set_transport_options.asciidoc | 5 +++++ doc/src/manual/ranch.start_listener.asciidoc | 2 ++ 4 files changed, 10 insertions(+), 24 deletions(-) (limited to 'doc') diff --git a/doc/src/manual/ranch.asciidoc b/doc/src/manual/ranch.asciidoc index ca8a789..bd022ec 100644 --- a/doc/src/manual/ranch.asciidoc +++ b/doc/src/manual/ranch.asciidoc @@ -64,23 +64,6 @@ when accepting new connections. Some connections may also be removed from this count explicitly by the user code. -=== opt() - -[source,erlang] ----- -opt() = {ack_timeout, timeout()} - | {connection_type, worker | supervisor} - | {max_connections, max_conns()} - | {num_acceptors, pos_integer()} - | {shutdown, timeout() | brutal_kill} ----- - -Deprecated form for Ranch-specific options. - -Please use the `opts()` type when you need to provide -Ranch-specific transport options. Socket options will -remain separate from the Ranch-specific options. - === opts() [source,erlang] @@ -106,13 +89,6 @@ option needs to be given) or as part of `socket_opts`. None of the options are required. -ack_timeout:: - -When `ack_timeout` is found in a transport options proplist, -it is converted to the `handshake_timeout` option from the -map. They are equivalent. The `ack_timeout` option will be -removed in Ranch 2.0. - connection_type (worker):: Type of process that will handle the connection. @@ -158,6 +134,7 @@ Unique name used to refer to a listener. * *2.0*: The option `max_connections` is now per connection supervisor. * *2.0*: The `num_conns_sup` option was added. * *2.0*: The `socket` option was removed. +* *2.0*: The `opt()` type was removed. * *1.6*: The `logger` option was added. * *1.6*: The `opt()` type was deprecated in favor of the new `opts()` type. diff --git a/doc/src/manual/ranch.child_spec.asciidoc b/doc/src/manual/ranch.child_spec.asciidoc index 88a7581..9fdf65a 100644 --- a/doc/src/manual/ranch.child_spec.asciidoc +++ b/doc/src/manual/ranch.child_spec.asciidoc @@ -74,6 +74,8 @@ Child specifications are returned. == Changelog +* *2.0*: The `TransOpts` argument must no longer contain + Ranch-specific options if given as a list. Use a map. * *1.4*: The `NumAcceptors` argument was moved to the transport options. == Examples diff --git a/doc/src/manual/ranch.set_transport_options.asciidoc b/doc/src/manual/ranch.set_transport_options.asciidoc index 51bc3f7..cba6ba7 100644 --- a/doc/src/manual/ranch.set_transport_options.asciidoc +++ b/doc/src/manual/ranch.set_transport_options.asciidoc @@ -34,6 +34,11 @@ The new transport options. The atom `ok` is always returned. It can be safely ignored. +== Changelog + +* *2.0*: The `TransOpts` argument must no longer contain + Ranch-specific options if given as a list. Use a map. + == Examples .Set the transport options diff --git a/doc/src/manual/ranch.start_listener.asciidoc b/doc/src/manual/ranch.start_listener.asciidoc index d73800c..eebcbeb 100644 --- a/doc/src/manual/ranch.start_listener.asciidoc +++ b/doc/src/manual/ranch.start_listener.asciidoc @@ -82,6 +82,8 @@ configured for Ranch is already in use. == Changelog +* *2.0*: The `TransOpts` argument must no longer contain + Ranch-specific options if given as a list. Use a map. * *1.4*: The `NumAcceptors` argument was moved to the transport options. == Examples -- cgit v1.2.3