Ranch 1.6.0

1 files changed, 482 insertions, 0 deletions

diff --git a/docs/index.xml b/docs/index.xml
index 33a58867..2d2d5c42 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -86,6 +86,18 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, OSX and Win
     </item>
     
     <item>
+      <title>Introduction</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</guid>
+      <description>Ranch is a socket acceptor pool for TCP protocols.
+Ranch aims to provide everything you need to accept TCP connections with a small code base and low latency while being easy to use directly as an application or to embed into your own.
+Prerequisites It is assumed the developer already knows Erlang and has some experience with socket programming and TCP protocols.
+Supported platforms Ranch is tested and supported on Linux, FreeBSD, OSX and Windows.</description>
+    </item>
+    
+    <item>
       <title>The modern Web</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/modern_web/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -242,6 +254,16 @@ The listener takes care of supervising all the acceptor and connection processes
     </item>
     
     <item>
+      <title>Listeners</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/listeners/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/listeners/</guid>
+      <description>A listener is a set of processes whose role is to listen on a port for new connections. It manages a pool of acceptor processes, each of them indefinitely accepting connections. When it does, it starts a new process executing the protocol handler code. All the socket programming is abstracted through the use of transport handlers.
+The listener takes care of supervising all the acceptor and connection processes, allowing developers to focus on building their application.</description>
+    </item>
+    
+    <item>
       <title>Starting and stopping</title>
       <link>https://ninenines.eu/docs/en/gun/1.0/guide/start/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -378,6 +400,19 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra
     </item>
     
     <item>
+      <title>Transports</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/transports/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/transports/</guid>
+      <description>A transport defines the interface to interact with a socket.
+Transports can be used for connecting, listening and accepting connections, but also for receiving and sending data. Both passive and active mode are supported, although all sockets are initialized as passive.
+TCP transport The TCP transport is a thin wrapper around gen_tcp.
+SSL transport The SSL transport is a thin wrapper around ssl.
+Ranch depends on ssl by default so any necessary dependencies will start when Ranch is started.</description>
+    </item>
+    
+    <item>
       <title>Overview</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/overview/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -440,6 +475,16 @@ Writing a protocol handler All protocol handlers must implement the ranch_protoc
     </item>
     
     <item>
+      <title>Protocols</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</guid>
+      <description>A protocol handler starts a connection process and defines the protocol logic executed in this process.
+Writing a protocol handler All protocol handlers must implement the ranch_protocol behavior which defines a single callback, start_link/4. This callback is responsible for spawning a new process for handling the connection. It receives four arguments: the name of the listener, the socket, the transport handler being used and the protocol options defined in the call to ranch:start_listener/5.</description>
+    </item>
+    
+    <item>
       <title>Getting started</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/getting_started/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -553,6 +598,16 @@ Embedding To embed Ranch in your application you can simply add the child specs
     </item>
     
     <item>
+      <title>Embedded mode</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/embedded/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/embedded/</guid>
+      <description>Embedded mode allows you to insert Ranch listeners directly in your supervision tree. This allows for greater fault tolerance control by permitting the shutdown of a listener due to the failure of another part of the application and vice versa.
+Embedding To embed Ranch in your application you can simply add the child specs to your supervision tree. This can all be done in the init/1 function of one of your application supervisors.</description>
+    </item>
+    
+    <item>
       <title>Limitations</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/limitations/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -681,6 +736,17 @@ This chapter isn&amp;apos;t specifically about Ranch, we assume here that you kn
     </item>
     
     <item>
+      <title>Writing parsers</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</guid>
+      <description>There are three kinds of protocols:
+Text protocols  Schema-less binary protocols  Schema-based binary protocols   This chapter introduces the first two kinds. It will not cover more advanced topics such as continuations or parser generators.
+This chapter isn&amp;apos;t specifically about Ranch, we assume here that you know how to read data from the socket. The data you read and the data that hasn&amp;apos;t been parsed is saved in a buffer.</description>
+    </item>
+    
+    <item>
       <title>Building</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/app/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -788,6 +854,16 @@ The server only needs to retain the certificate serial number and the certificat
     </item>
     
     <item>
+      <title>SSL client authentication</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/ssl_auth/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/ssl_auth/</guid>
+      <description>Purpose SSL client authentication is a mechanism allowing applications to identify certificates. This allows your application to make sure that the client is an authorized certificate, but makes no claim about whether the user can be trusted. This can be combined with a password based authentication to attain greater security.
+The server only needs to retain the certificate serial number and the certificate issuer to authenticate the certificate. Together, they can be used to uniquely identify a certicate.</description>
+    </item>
+    
+    <item>
       <title>Packages and dependencies</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/deps/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -910,6 +986,16 @@ Note that for everything related to efficiency and performance, you should perfo
     </item>
     
     <item>
+      <title>Internals</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</guid>
+      <description>This chapter may not apply to embedded Ranch as embedding allows you to use an architecture specific to your application, which may or may not be compatible with the description of the Ranch application.
+Note that for everything related to efficiency and performance, you should perform the benchmarks yourself to get the numbers that matter to you. Generic benchmarks found on the web may or may not be of use to you, you can never know until you benchmark your own system.</description>
+    </item>
+    
+    <item>
       <title>Constraints</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/constraints/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -981,6 +1067,16 @@ RELX_CONFIG = $(CURDIR)/webchat.config  Relx does not need to be installed. Erla
     </item>
     
     <item>
+      <title>Upcoming changes in Ranch 2.0</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/upcoming_2.0_changes/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/upcoming_2.0_changes/</guid>
+      <description>The following changes will be done in Ranch 2.0. In most cases an alternative is already available in the most recent Ranch version.
+The function ranch:start_listener/6 has been deprecated in favor of ranch:start_listener/5. The number of acceptors was removed and will be taken from the transport options.  The function ranch:child_spec/6 has also been deprecated, in favor of ranch:child_spec/5.  The function ranch:accept_ack/1 has been deprecated in favor of ranch:handshake/1,2.  The function ranch:info/1,2 will return a map containing each listener&amp;apos;s information rather than a list of key/values.</description>
+    </item>
+    
+    <item>
       <title>Self-extracting releases</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/sfx/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -1070,6 +1166,17 @@ Requirements Erlang.mk uses p7zip by default to generate the escript archive. Ma
     </item>
     
     <item>
+      <title>Migrating from Ranch 1.5 to 1.6</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.5/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.5/</guid>
+      <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0.
+Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed.
+Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes.  Transport options can now be updated for suspended listeners.</description>
+    </item>
+    
+    <item>
       <title>Loop handlers</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/loop_handlers/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -1195,6 +1302,16 @@ In this chapter I will use the term Rebar project to refer to a project built us
     </item>
     
     <item>
+      <title>Migrating from Ranch 1.x</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</guid>
+      <description>The changelog for Ranch releases before 1.6 can be found in this section.
+1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2  Fix ranch:info/0 and ranch:procs/2 in embedded mode  Prevent ranch_conns_sup from stopping on unexpected messages   1.4.0 Add new transport option num_acceptor  Deprecate ranch:start_listener/6 in favor of start_listener/5  Deprecate ranch:child_spec/6 in favor of child_spec/5   1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description>
+    </item>
+    
+    <item>
       <title>AsciiDoc documentation</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/asciidoc/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -2538,6 +2655,20 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu
     </item>
     
     <item>
+      <title>Ranch Function Reference</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/</guid>
+      <description>Name ranch - Socket acceptor pool for TCP protocols
+Description Ranch is a socket acceptor pool for TCP protocols.
+Ranch manages listeners which are a set of processes that accept and manage connections. The connection&amp;apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.
+Modules Functions:
+ranch(3) - Socket acceptor pool   Transports:
+ranch_ssl(3) - SSL transport  ranch_tcp(3) - TLS transport   Behaviors:</description>
+    </item>
+    
+    <item>
       <title>Ranch User Guide</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/guide/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -2574,6 +2705,15 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu
     </item>
     
     <item>
+      <title>Ranch User Guide</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/</guid>
+      <description>Interface Introduction  Listeners  Transports  Protocols  Embedded mode   How to Writing parsers  SSL client authentication   Advanced Internals   Additional information Upcoming changes in Ranch 2.0  Migrating from Ranch 1.5 to 1.6  Migrating from Ranch 1.x   </description>
+    </item>
+    
+    <item>
       <title>cowboy(3)</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/manual/cowboy/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7093,6 +7233,20 @@ opt() opt() = {ack_timeout, timeout()} | {connection_type, worker | supervisor}
     </item>
     
     <item>
+      <title>ranch(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch/</guid>
+      <description>Name ranch - Socket acceptor pool
+Description The module ranch provides functions for starting and manipulating Ranch listeners.
+Exports Start/stop:
+ranch:start_listener(3) - Start a listener  ranch:stop_listener(3) - Stop a listener  ranch:child_spec(3) - Build child specifications for a new listener   Suspend/resume:
+ranch:suspend_listener(3) - Suspend a running listener  ranch:resume_listener(3) - Resume a suspended listener  ranch:get_status(3) - Get a listener&amp;apos;s running state   Connections:
+ranch:accept_ack(3) - Deprecated in favor of ranch:handshake(3)  ranch:handshake(3) - Perform the transport handshake  ranch:remove_connection(3) - Remove connection from the count   Options:</description>
+    </item>
+    
+    <item>
       <title>ranch(7)</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/manual/ranch_app/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7146,6 +7300,268 @@ profile (false) When enabled, Ranch will start eprof profiling automatically.
     </item>
     
     <item>
+      <title>ranch(7)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_app/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_app/</guid>
+      <description>Name ranch - Socket acceptor pool for TCP protocols
+Description Ranch is a socket acceptor pool for TCP protocols.
+Ranch manages listeners which are a set of processes that accept and manage connections. The connection&amp;apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service.
+Modules Functions:
+ranch(3) - Socket acceptor pool   Transports:
+ranch_ssl(3) - SSL transport  ranch_tcp(3) - TLS transport   Behaviors:</description>
+    </item>
+    
+    <item>
+      <title>ranch:child_spec(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.child_spec/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.child_spec/</guid>
+      <description>Name ranch:child_spec - Build child specifications for a new listener
+Description child_spec(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&amp;gt; supervisor:child_spec()  Build child specifications for a new listener.
+This function can be used to embed a listener directly in an application&amp;apos;s supervision tree.
+Arguments Ref The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the configuration.</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_addr(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_addr/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_addr/</guid>
+      <description>Name ranch:get_addr - Get the listening port and IP
+Description get_addr(Ref :: ranch:ref()) -&amp;gt; {IP :: inet:ip_address(), Port :: inet:port_number()}  Get the listening port and IP.
+Arguments Ref The listener name.
+  Return value The address of the listener is returned as a tuple.
+The IP address is the IP of the network interface the socket is bound to.
+Examples Get the listening port and IP {IP, Port} = ranch:get_addr(example).</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_max_connections(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_max_connections/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_max_connections/</guid>
+      <description>Name ranch:get_max_connections - Get the max number of connections
+Description get_max_connections(Ref :: ranch:ref()) -&amp;gt; MaxConns :: ranch:max_conns()  Get the max number of connections.
+Arguments Ref The listener name.
+  Return value The maximum number of connections is returned.
+Examples Get the max number of connections MaxConns = ranch:get_max_connections(example).  See also ranch:get_protocol_options(3), ranch:get_transport_options(3), ranch:set_max_connections(3), ranch(3)</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_port(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_port/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_port/</guid>
+      <description>Name ranch:get_port - Get the listening port
+Description get_port(Ref :: ranch:ref()) -&amp;gt; Port :: inet:port_number()  Get the listening port.
+This function is particularly useful to retrieve the listening port number when it was not provided in the options and was chosen randomly instead.
+Arguments Ref The listener name.
+  Return value The listening port is returned.
+Examples Get the listening port Port = ranch:get_port(example).  See also ranch:start_listener(3), ranch:get_addr(3), ranch:info(3), ranch(3)</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_protocol_options(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_protocol_options/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_protocol_options/</guid>
+      <description>Name ranch:get_protocol_options - Get the current protocol options
+Description get_protocol_options(Ref :: ranch:ref()) -&amp;gt; ProtoOpts :: any()  Get the current protocol options.
+Arguments Ref The listener name.
+  Return value The current protocol options are returned.
+Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options(example).  See also ranch:get_max_connections(3), ranch:get_transport_options(3), ranch:set_protocol_options(3), ranch(3)</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_status(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_status/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_status/</guid>
+      <description>Name ranch:get_status - Get a listener&amp;apos;s running state
+Description get_status(Ref :: ranch_ref()) -&amp;gt; running | suspended  Get a listener&amp;apos;s running state.
+Arguments Ref The listener name.
+  Return value An atom is returned indicating the running status of the listener.
+Changelog 1.6: Function introduced.   Examples Get a listener&amp;apos;s running state ranch:get_status(example).  See also ranch:start_listener(3), ranch:stop_listener(3), ranch:suspend_listener(3), ranch:resume_listener(3), ranch:set_transport_options(3), ranch:wait_for_connections(3), ranch(3)</description>
+    </item>
+    
+    <item>
+      <title>ranch:get_transport_options(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_transport_options/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.get_transport_options/</guid>
+      <description>Name ranch:get_transport_options - Get the current transport options
+Description get_transport_options(Ref :: ranch:ref()) -&amp;gt; TransOpts :: any()  Get the current transport options.
+Arguments Ref The listener name.
+  Return value The current transport options are returned.
+Examples Get the current transport options TransOpts = ranch:get_transport_options(example).  See also ranch:get_max_connections(3), ranch:get_protocol_options(3), ranch:set_transport_options(3), ranch(3)</description>
+    </item>
+    
+    <item>
+      <title>ranch:handshake(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.handshake/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.handshake/</guid>
+      <description>Name ranch:handshake - Perform the transport handshake
+Description handshake(Ref) -&amp;gt; handshake(Ref, []) handshake(Ref, Opts) -&amp;gt; {ok, Socket} Ref :: ranch:ref() Opts :: any() Socket :: any()  Perform the transport handshake.
+This function must be called by the protocol process in order to retrieve the socket for the connection. Ranch performs the handshake necessary to give control of the socket to this process and also does the transport handshake, for example setting up the TLS connection.</description>
+    </item>
+    
+    <item>
+      <title>ranch:info(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.info/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.info/</guid>
+      <description>Name ranch:info - Overview of Ranch listeners
+Description info() -&amp;gt; [{Ref, Info}] info(Ref) -&amp;gt; Info Info :: [{Key :: atom(), Value :: any()}]  Overview of Ranch listeners.
+Arguments Ref The listener name.
+  Return value Returns detailed information about one or all Ranch listeners. The following keys are returned:
+pid Pid of the listener&amp;apos;s top-level supervisor.
+ status Listener status, either running or suspended.
+ ip Interface Ranch listens on.</description>
+    </item>
+    
+    <item>
+      <title>ranch:procs(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.procs/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.procs/</guid>
+      <description>Name ranch:procs - Retrieve pids from a listener
+Description procs(Ref :: ranch:ref(), Type :: acceptors | connections) -&amp;gt; Pids :: [pid()]  Retrieve pids from a listener.
+Arguments Ref The listener name.
+ Type The type of process that will be returned.
+  Return value A list of pids is returned.
+Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors).  Get the pids of the connection processes Pids = ranch:procs(connections).</description>
+    </item>
+    
+    <item>
+      <title>ranch:remove_connection(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.remove_connection/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.remove_connection/</guid>
+      <description>Name ranch:remove_connection - Remove connection from the count
+Description remove_connection(Ref :: ranch:ref()) -&amp;gt; ok  Remove connection from the count.
+This connection will no longer be included in the count when limiting the number of connections. This can be useful in a mixed environment where some connections are active and others are passive. Passive connections spend most of their time idling and are not consuming much resources.
+This function may only be called from a connection process.</description>
+    </item>
+    
+    <item>
+      <title>ranch:resume_listener(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.resume_listener/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.resume_listener/</guid>
+      <description>Name ranch:resume_listener - Resume a suspended listener
+Description resume_listener(Ref :: ranch_ref()) -&amp;gt; ok | {error, any()}  Resume a suspended listener.
+Ranch will start listening for and accepting connections again. The function ranch:set_transport_options(3) can be used to change the transport options before resuming the listener.
+Nothing is done when the listener is already running.
+Arguments Ref The listener name.
+  Return value The atom ok is returned on success.</description>
+    </item>
+    
+    <item>
+      <title>ranch:set_max_connections(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_max_connections/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_max_connections/</guid>
+      <description>Name ranch:set_max_connections - Set the max number of connections
+Description set_max_connections(Ref :: ranch:ref(), MaxConns :: ranch:max_conns()) -&amp;gt; ok  Set the max number of connections.
+The change will be applied immediately. If the new value is smaller than the previous one, Ranch will wait for the extra connections to terminate and will not accept new connections until the number of connections goes below the limit.
+Arguments Ref The listener name.</description>
+    </item>
+    
+    <item>
+      <title>ranch:set_protocol_options(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_protocol_options/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_protocol_options/</guid>
+      <description>Name ranch:set_protocol_options - Set the protocol options
+Description set_protocol_options(Ref :: ranch:ref(), ProtoOpts :: any()) -&amp;gt; ok  Set the protocol options.
+The change will be applied immediately for all new connections. Old connections will not receive the new options.
+Arguments Ref The listener name.
+ ProtoOpts The new protocol options.
+  Return value The atom ok is always returned. It can be safely ignored.
+Examples Set the protocol options ranch:set_protocol_options(example, ProtoOpts).</description>
+    </item>
+    
+    <item>
+      <title>ranch:set_transport_options(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_transport_options/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.set_transport_options/</guid>
+      <description>Name ranch:set_transport_options - Set the transport options
+Description set_transport_options(Ref :: ranch:ref(), TransOpts :: any()) -&amp;gt; ok | {error, running}  Set the transport options.
+The listener must be suspended for this call to succeed. If the listener is running, {error, running} will be returned.
+The change will take effect when the listener resumes.
+Arguments Ref The listener name.
+ TransOpts The new transport options.
+  Return value The atom ok is always returned.</description>
+    </item>
+    
+    <item>
+      <title>ranch:start_listener(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.start_listener/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.start_listener/</guid>
+      <description>Name ranch:start_listener - Start a listener
+Description start_listener(Ref :: ranch_ref(), Transport :: module(), TransOpts :: ranch:opts(), Protocol :: module(), ProtoOpts :: any()) -&amp;gt; {ok, ListenerPid :: pid()} | {error, any()}  Start a listener.
+A listener is a set of processes that accepts and manages connections using the given transport and protocol modules.
+Arguments Ref The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the configuration.</description>
+    </item>
+    
+    <item>
+      <title>ranch:stop_listener(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.stop_listener/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.stop_listener/</guid>
+      <description>Name ranch:stop_listener - Stop a listener
+Description stop_listener(Ref :: ranch_ref()) -&amp;gt; ok | {error, not_found}  Stop a listener.
+The listener is stopped gracefully, first by closing the listening port, then by stopping the connection processes. These processes are stopped according to the shutdown transport option, which may be set to brutally kill all connection processes or give them some time to stop properly.
+In order for the connection processes to exit gracefully, they need to trap exit signals and stop before the configured shutdown timeout.</description>
+    </item>
+    
+    <item>
+      <title>ranch:suspend_listener(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.suspend_listener/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.suspend_listener/</guid>
+      <description>Name ranch:suspend_listener - Suspend a running listener
+Description suspend_listener(Ref :: ranch_ref()) -&amp;gt; ok | {error, any()}  Suspend a running listener.
+Ranch will stop listening for and accepting connections and the listening socket will be closed. Existing connections will continue undisturbed. The function ranch:wait_for_connections(3) can be used to wait for connections to be closed if necessary.
+Some transport options can only be changed when the listener is suspended. Please consult the ranch:set_transport_options(3) manual for more information.</description>
+    </item>
+    
+    <item>
+      <title>ranch:wait_for_connections(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.wait_for_connections/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch.wait_for_connections/</guid>
+      <description>Name ranch:wait_for_connections - Wait for a specific number of connections
+Description wait_for_connections(Ref :: ranch:ref(), Operator, NumConns :: non_neg_integer()) -&amp;gt; ok Operator :: &#39;&amp;gt;&#39; | &#39;&amp;gt;=&#39; | &#39;==&#39; | &#39;=&amp;lt;&#39; | &#39;&amp;lt;&#39;  Wait for a specific number of connections.
+This function waits until the number of connections on the given listener becomes higher than, equal to or lower than the given number. It never returns otherwise.
+This function can be used to gracefully shutdown a listener by first suspending the listener and then waiting for connections to terminate before finally stopping the listener.</description>
+    </item>
+    
+    <item>
       <title>ranch_protocol(3)</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/manual/ranch_protocol/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7210,6 +7626,19 @@ Callbacks start_link(Ref, Socket, Transport, ProtoOpts) -&amp;gt; {ok, pid()} |
     </item>
     
     <item>
+      <title>ranch_protocol(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_protocol/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_protocol/</guid>
+      <description>Name ranch_protocol - Protocol modules
+Description The module ranch_protocol defines the interface used by Ranch protocols.
+Callbacks Ranch protocols implement the following interface:
+start_link(Ref :: ranch:ref(), _, Transport :: module(), ProtoOpts :: any()) -&amp;gt; {ok, ConnPid :: pid()} | {ok, SupPid :: pid(), ConnPid :: pid()}  Start a new connection process.
+The only purpose of this callback is to start a process that will handle the socket. It must spawn the process, link and then return the new pid.</description>
+    </item>
+    
+    <item>
       <title>ranch_ssl(3)</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/manual/ranch_ssl/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7254,6 +7683,21 @@ Types ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {beast_miti
     </item>
     
     <item>
+      <title>ranch_ssl(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_ssl/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_ssl/</guid>
+      <description>Name ranch_ssl - SSL transport
+Description The module ranch_ssl implements an SSL Ranch transport.
+Exports The module ranch_ssl implements the interface defined by ranch_transport(3).
+Types opt() opt() :: ranch_tcp:opt() | ssl_opt()  Listen options.
+The TCP options are defined in ranch_tcp(3).
+opts() opts() :: [opt()]  List of listen options.
+ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {beast_mitigation, one_n_minus_one | zero_n | disabled} | {cacertfile, string()} | {cacerts, [public_key:der_encoded()]} | {cert, public_key:der_encoded()} | {certfile, string()} | {ciphers, [ssl:erl_cipher_suite()] | string()} | {client_renegotiation, boolean()} | {crl_cache, {module(), {internal | any(), list()}}} | {crl_check, boolean() | peer | best_effort} | {depth, 0.</description>
+    </item>
+    
+    <item>
       <title>ranch_tcp(3)</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/manual/ranch_tcp/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7302,6 +7746,19 @@ Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} |
     </item>
     
     <item>
+      <title>ranch_tcp(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_tcp/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_tcp/</guid>
+      <description>Name ranch_tcp - TCP transport
+Description The module ranch_tcp implements a TCP Ranch transport.
+The function sendfile may not work correctly when used against files stored in a VirtualBox shared folder.
+Exports The module ranch_tcp implements the interface defined by ranch_transport(3).
+Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | {delay_send, boolean()} | {dontroute, boolean()} | {exit_on_close, boolean()} | {fd, non_neg_integer()} | {high_msgq_watermark, non_neg_integer()} | {high_watermark, non_neg_integer()} | inet | inet6 | {ip, inet:ip_address()} | {ipv6_v6only, boolean()} | {keepalive, boolean()} | {linger, {boolean(), non_neg_integer()}} | {low_msgq_watermark, non_neg_integer()} | {low_watermark, non_neg_integer()} | {nodelay, boolean()} | {port, inet:port_number()} | {priority, integer()} | {raw, non_neg_integer(), non_neg_integer(), binary()} | {recbuf, non_neg_integer()} | {send_timeout, timeout()} | {send_timeout_close, boolean()} | {sndbuf, non_neg_integer()} | {tos, integer()}  Listen options.</description>
+    </item>
+    
+    <item>
       <title>ranch_transport(3)</title>
       <link>https://ninenines.eu/docs/en/ranch/1.2/manual/ranch_transport/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -7361,5 +7818,30 @@ Callbacks accept(LSocket, Timeout) -&amp;gt; {ok, CSocket} | {error, closed | ti
   Accept a connection on the given listening socket.</description>
     </item>
     
+    <item>
+      <title>ranch_transport(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport/</guid>
+      <description>Name ranch_transport - Transport modules
+Description The module ranch_transport defines the interface used by Ranch transports.
+Callbacks Ranch transports implement the following interface:
+accept accept(LSocket :: socket(), Timeout :: timeout()) -&amp;gt; {ok, Socket :: socket()} | {error, closed | timeout | atom()}  Use the listening socket returned by listen/1 to accept a new connection. The timeout is specified in milliseconds.
+close close(Socket :: socket()) -&amp;gt; ok  Close the socket.</description>
+    </item>
+    
+    <item>
+      <title>ranch_transport:sendfile(3)</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport.sendfile/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/ranch_transport.sendfile/</guid>
+      <description>Name ranch_transport:sendfile - Send a file on the socket
+Description sendfile(Transport :: module(), Socket :: ranch_transport:socket(), File :: file:name_all() | file:fd(), Offset :: non_neg_integer(), Bytes :: non_neg_integer(), Opts :: ranch_transport:sendfile_opts()) -&amp;gt; {ok, SentBytes :: non_neg_integer()} | {error, atom()}  Send a file on the socket.
+The file may be sent full or in parts, and may be specified by its filename or by an already open file descriptor.
+This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description>
+    </item>
+    
   </channel>
 </rss>
\ No newline at end of file