aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
AgeCommit message (Collapse)Author
2019-07-16Update documentation for embedded listenersjuhlig
2019-07-16Document connection draining on application shutdownjuhlig
2019-07-10Document connection drainingjuhlig
2019-07-02Set transport options without suspendjuhlig
Lift the restriction that a listener must be suspended before transport options can be changed. * Changes to the `max_connections`, `handshake_timeout` and `shutdown` options will take effect immediately. * Changes to the `num_acceptors`, `num_listen_sockets` and `socket_opts` options will take effect when a listener is suspended and resumed, or when the acceptors supervisor restarts. * Changes to the `num_conns_sups` and `connection_type` options will only take effect when the connections super-supervisor restarts. * Changes to the `logger` option will never take effect, unless a listener is stopped and started with fresh transport options. The fetching and handing down of transport options changes with this commit, to ensure consistency between the individual components in the hierarchy. * The `num_acceptors` option is handed down from the listener supervisor to the acceptors supervisor in the child spec, while the `num_listen_sockets` and `socket_opts` options are read inside the acceptors supervisor itself. This way, the `num_acceptors` option will only take effect when the listener supervisor restarts, whereas the other two options will take effect when acceptors supervisor restarts. This commit moves the fetching of the `num_acceptors` option into the acceptors supervisor as well. * The `logger` option is read in multiple places throughout the hierarchy. This way it may happen that processes that suffered a crash and restart may use a different logger than other processes that did not. This commit reads the `logger` from the transport options given to the listener supervisor start function, and hands it down from there. * The `connection_type` option is read individually by each connection supervisor. This way, a restart of an individual connection supervisor may cause them to use a different connection type than the others. This commit reads the transport options in the connections super-supervisor, and hands them down to the individual connections supervisors. * The `num_conns_sups` is handed down from the listener supervisor to the connections super-supervisor. This way, a change to this option will only take effect when the listener supervisor restarts. This commit moves the fetching of this option inside the connections super-supervisor. This change is merely for structural consistency, it is not necessary for operational consistency.
2019-05-27Use transport options in ranch_transport:listen/1 callbacksjuhlig
The callback `ranch_transport:listen/1` has changed to accept a map of transport options instead of socket options.
2019-05-22Add docs for local socketsjuhlig
2019-05-09Remove Socket argument from ranch_protocol:start_linkLoïc Hoguin
2019-05-08Remove a paragraph about the old socket optionLoïc Hoguin
2019-05-08Add the num_conns_sups optionjuhlig
This new option allows configuring the number of connection supervisors. The old behavior can be obtained by setting this value to 1. A value larger than num_acceptors will result in some connection supervisors not being used as the acceptors currently only use one connection supervisor.
2019-04-29Remove socket optionj.uhlig
2018-11-28Ranch 1.7.11.7.1Loïc Hoguin
2018-11-14Update the migration guide for 1.71.7.0Loïc Hoguin
2018-10-08Drop support for Erlang/OTP 18Loïc Hoguin
2018-09-17Ranch 1.6.21.6.2Loïc Hoguin
2018-08-13Ranch 1.6.11.6.1Loïc Hoguin
2018-08-01More release notesLoïc Hoguin
2018-08-01Use fn/1,2 instead of fn/{1,2} everywhereLoïc Hoguin
2018-08-01Ranch 1.6Loïc Hoguin
2018-08-01Remove R16 compatibilityLoïc Hoguin
Ranch is now made for and tested on 18+ only.
2018-07-18Add one manual per function for the ranch moduleLoïc Hoguin
Also review and update the ranch(7) manual and fix a few specs.
2018-07-04Enable TLS upgrades via ranch_ssl:handshake/3Loïc Hoguin
Based on the work done by @juhlig.
2018-07-04Document upcoming changes in Ranch 2.0Loïc Hoguin
2018-07-02Introduce Transport:handshake/1,2j.uhlig
This commit deprecates Transport:accept_ack/1 in favor of a new forward-compatible function. Transport:handshake/1,2 will use ssl:handshake/2,3 from Ranch 2.0 onward.
2018-05-07Replace gen_server with gen_statem in examplesj.uhlig
2018-05-02Add suspend/resume of listeners and update of transport optionsj.uhlig
This allows graceful draining of connections, updating transport options on a running listener without having to drop connections and other similar scenarios. Note that when updating transport options the listener must be suspended which means that new connections will be rejected until the listener is resumed.
2017-05-31Deprecated ranch:start_listener/6 and child_spec/6Loïc Hoguin
The NumAcceptors argument has been moved to transport option num_acceptor, which defaults to 10. The functions now take one less argument. The old functions are still here, though deprecated.
2016-11-25Update docs about the dependency on sslLoïc Hoguin
2016-11-24Add ranch:info/0 and ranch:procs/2Loïc Hoguin
Provides detailed information about Ranch listeners
2016-11-15Refer to the tcp_reverse example for full gen_serverLoïc Hoguin
2016-11-15Remove bad advice for gen_server protocolsLoïc Hoguin
Also improves the good example a little by using spawn_link instead of start_link.
2016-11-15Clarify max_connections + NbAcceptors + backlog in the guideLoïc Hoguin
2016-11-15Update support listLoïc Hoguin
We now do R16B+ (because R15 doesn't compile anymore on my CI servers), except 18.3.2 and 18.3.3 (known SSL issues). Also update the list of supported platforms.
2016-09-19Don't silently drop the accept rateMaas-Maarten Zeeman
2016-09-19Fix a spelling issue in guidedeveloperworks
2016-01-20Fix a link in the user guideLoïc Hoguin
2015-08-22Convert the documentation to AsciidocLoïc Hoguin