aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
AgeCommit message (Collapse)Author
2021-09-07Tweak the alarms documentationLoïc Hoguin
2021-09-07Manual for num_connection alarmsMaria Scott
2021-09-03Add function ranch_proxy_header:to_connection_info/1Loïc Hoguin
2021-09-01Fix typosKian-Meng, Ang
2021-09-01Update docs and modernize examplesJan Uhlig
* Use the map form for transport options everywhere * Remove mentions of the list form for transport options * Use a state enter call instead of gen_statem:enter_loop/4 and proc_lib:start_link/3 in the tcp_reverse example * Take care of different EOLs in the tcp_reverse example * Mention state enter calls, the next_event action, and {continue, ...} in the docs for how to use gen_statem and gen_server
2021-09-01Add post-listen callbackJan Uhlig
2020-12-04Clarify {get,set}_{protocol,transport}_options docsViktor Söderqvist
Clarifications and examples.
2020-09-10Metric counters for connection accepts and terminatesMaria-12648430
2020-06-25ssl_opt() was updated for OTP-23 not OTP-22Loïc Hoguin
2020-06-25Add new ssl options introduced with OTP/23juhlig
2019-10-14Enable multiple steps handshakejuhlig
Also fix some Protocol:start_link/4 into start_link/3 left over in the documentation.
2019-07-18Return listener info as a map2.0.0-rc.1juhlig
2019-07-17Fix documentation for set_transport_optionsjuhlig
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-06-21Embedded listeners depending on ranch_serverjuhlig
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-27Update ranch_ssl:ssl_opt() to conform with OTP 22 ssljuhlig
2019-05-22Add docs for local socketsjuhlig
2019-05-13Add the passive messages to ranch_transport:messages/0Loïc Hoguin
2019-05-12Properly document logger option; change default to loggerLoïc Hoguin
We now require OTP-21+ therefore there's no need to keep the default of error_logger.
2019-05-09Remove Socket argument from ranch_protocol:start_linkLoïc Hoguin
2019-05-09Use ssl:handshake instead of ssl:ssl_acceptLoïc Hoguin
This makes Ranch require OTP-21+. The function ranch:accept_ack/1 was also removed in this commit.
2019-05-09No longer accept mix of Ranch/socket options as listLoï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-26Use the correct CRC32 algorithm for the PROXY headerLoïc Hoguin
Turns out it wasn't the plain CRC32 algorithm that should have been used, whoops! The implementation was adapted from pseudo code from Thomas Cioppettini. I've renamed the PROXY header building option value for checksum from crc32 to crc32c and updated the documentation. There is no support for plain crc32 checksums.
2018-11-14Document the PROXY-related functions; prepare 1.7.0Loïc Hoguin
2018-10-10Correct a typo in a manual page titleLoïc Hoguin
2018-07-31Revisit the manual pages for the various modulesLoïc Hoguin
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-04Fix a typo in a type in the documentationLoïc Hoguin
2018-07-04Better distinguish between Ranch and socket optionsLoïc Hoguin
A map should now be used when specifying transport options that contain more than just socket options. It is still possible to pass a list of socket options directly as a convenience. The ack_timeout is renamed to handshake_timeout when specified as a map. This corresponds to the new function ranch:handshake/1,2 that will be favored in Ranch 2.0. Specifying Ranch-specific options via the proplist will no longer be possible starting from Ranch 2.0.
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-17Add a function to wait for number of connectionsj.uhlig
LH: Reworked validation style and added a -dialyzer attribute to acceptor_SUITE to silence expected errors.
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.
2018-01-22Added transport functions getopts/2, getstat/1 and getstat/2Jan Uhlig
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-01Add SSL options for legacy software interoperabilityAlexandru Munteanu
2016-10-09Make values for the TLS 1.2 signature_algorithms extension configurableVictor
Added in ssl-7.3.1 (OTP-13261). Documented in ssl-8.0.
2016-09-19Renaming NbAcceptors to NumAcceptorsferigis
2016-09-19Add ipv6_v6only listen optionMarc Worrell
2015-08-25Add ranch:get_addr/1Loïc Hoguin
2015-08-22Convert the documentation to AsciidocLoïc Hoguin