diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/guide/listeners.asciidoc | 25 | ||||
| -rw-r--r-- | doc/src/manual/ranch.set_transport_options.asciidoc | 26 |
2 files changed, 37 insertions, 14 deletions
diff --git a/doc/src/guide/listeners.asciidoc b/doc/src/guide/listeners.asciidoc index 94552ba..df94896 100644 --- a/doc/src/guide/listeners.asciidoc +++ b/doc/src/guide/listeners.asciidoc @@ -358,14 +358,23 @@ Opts = ranch:get_protocol_options(tcp_echo). === Changing transport options -Ranch allows you to change the transport options of a listener, for -example to make it listen on a different port. - -To change transport options, the listener has to be suspended first. -Then you are allowed to change the transport options by calling -`ranch:set_transport_options/2` with the listener name and the new -transport options as arguments. -After that, you can resume the listener. +Ranch allows you to change the transport options of a listener with +the `ranch:set_transport_options/2` function, for example to change the +number of acceptors or to make it listen on a different port. + +Changes to the following options will take effect... + +* immediately: +** `max_connections` +** `handshake_timeout` +** `shutdown` +* only after the listener has been suspended and resumed: +** `num_acceptors` +** `num_listen_sockets` +** `socket_opts` +* only when the entire listener is restarted: +** `num_conns_sups` +** `logger` .Changing the transport options diff --git a/doc/src/manual/ranch.set_transport_options.asciidoc b/doc/src/manual/ranch.set_transport_options.asciidoc index cba6ba7..6c349ca 100644 --- a/doc/src/manual/ranch.set_transport_options.asciidoc +++ b/doc/src/manual/ranch.set_transport_options.asciidoc @@ -9,16 +9,25 @@ ranch:set_transport_options - Set the transport options [source,erlang] ---- set_transport_options(Ref :: ranch:ref(), - TransOpts :: any()) - -> ok | {error, running} + TransOpts :: ranch:opts()) + -> ok | {error, Reason :: term()} ---- Set the transport options. -The listener must be suspended for this call to succeed. -If the listener is running, `{error, running}` will be returned. +Changes to the following options will take effect... -The change will take effect when the listener resumes. +* immediately: +** `max_connections` +** `handshake_timeout` +** `shutdown` +* only after the listener has been suspended and resumed: +** `num_acceptors` +** `num_listen_sockets` +** `socket_opts` +* only when the entire listener is restarted: +** `num_conns_sups` +** `logger` == Arguments @@ -32,10 +41,15 @@ The new transport options. == Return value -The atom `ok` is always returned. It can be safely ignored. +The atom `ok` is returned on success. + +An error tuple is returned on failure, for example if the given +transport options contain invalid values. == Changelog +* *2.0*: The restriction that the listener must be suspended + has been removed. * *2.0*: The `TransOpts` argument must no longer contain Ranch-specific options if given as a list. Use a map. |