diff options
Diffstat (limited to 'docs/index.xml')
| -rw-r--r-- | docs/index.xml | 695 |
1 files changed, 556 insertions, 139 deletions
diff --git a/docs/index.xml b/docs/index.xml index a728cc0f..1cd6902c 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -87,10 +87,10 @@ Copyright (c) 2013-2020, Loïc Hoguin &lt;[email protected]&gt; Permiss <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/introduction/</link> + <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.5/guide/introduction/</guid> + <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. @@ -99,10 +99,10 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, OSX and Win <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/introduction/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/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> + <guid>https://ninenines.eu/docs/en/ranch/1.7/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. @@ -111,10 +111,10 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, OSX and Win <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/introduction/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/introduction/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. @@ -123,22 +123,22 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, OSX and Win <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/introduction/</link> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/introduction/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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> +Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and Windows.</description> </item> <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/introduction/</link> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/introduction/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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. @@ -273,16 +273,6 @@ The Web is concurrent When you access a website there is little concurrency invo <item> <title>Listeners</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/listeners/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/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>Listeners</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -322,6 +312,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/2.1/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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> @@ -515,10 +515,10 @@ Cowboy is a high quality project. It has a small code base, is very efficient (b <item> <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/transports/</link> + <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.5/guide/transports/</guid> + <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. @@ -528,10 +528,10 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra <item> <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/transports/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/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> + <guid>https://ninenines.eu/docs/en/ranch/1.7/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. @@ -541,10 +541,10 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra <item> <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/transports/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/transports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/transports/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. @@ -554,10 +554,10 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra <item> <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/transports/</link> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/transports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/transports/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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. @@ -567,10 +567,10 @@ Ranch depends on ssl by default so any necessary dependencies will start when Ra <item> <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/transports/</link> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/transports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/transports/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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. @@ -635,16 +635,6 @@ A Gun connection is an Erlang process that manages a socket to a remote endpoint <item> <title>Protocols</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/protocols/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/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>Protocols</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -684,6 +674,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/2.1/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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/3. This callback is responsible for spawning a new process for handling the connection. It receives three arguments: the name of the listener, 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.4/guide/getting_started/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -805,16 +805,6 @@ Streams can be canceled at any time.</description> <item> <title>Embedded mode</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/embedded/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/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>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> @@ -854,6 +844,16 @@ However, just as for non-embedded listeners that were started via ranch:start_li </item> <item> + <title>Embedded mode</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/embedded/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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. +However, just as for non-embedded listeners that were started via ranch:start_listener/5, it is required that the ranch application is running before you can start embedded listeners. Furthermore, this also means that embedded listeners will restart when ranch_sup fails.</description> + </item> + + <item> <title>Flow diagram</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/flow_diagram/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -982,10 +982,10 @@ You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</descrip <item> <title>Writing parsers</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/parsers/</link> + <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.5/guide/parsers/</guid> + <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&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&apos;t been parsed is saved in a buffer.</description> @@ -993,10 +993,10 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn <item> <title>Writing parsers</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/parsers/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/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> + <guid>https://ninenines.eu/docs/en/ranch/1.7/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&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&apos;t been parsed is saved in a buffer.</description> @@ -1004,10 +1004,10 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn <item> <title>Writing parsers</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/parsers/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/parsers/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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&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&apos;t been parsed is saved in a buffer.</description> @@ -1015,10 +1015,10 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn <item> <title>Writing parsers</title> - <link>https://ninenines.eu/docs/en/ranch/1.8/guide/parsers/</link> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/parsers/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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&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&apos;t been parsed is saved in a buffer.</description> @@ -1026,10 +1026,10 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn <item> <title>Writing parsers</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/parsers/</link> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/parsers/</guid> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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&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&apos;t been parsed is saved in a buffer.</description> @@ -1144,16 +1144,6 @@ Cowboy provides two types of listeners: one listening for clear TCP connections, <item> <title>SSL client authentication</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/ssl_auth/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/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>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> @@ -1193,6 +1183,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/2.1/guide/ssl_auth/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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 certificate.</description> + </item> + + <item> <title>Routing</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/routing/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1275,13 +1275,13 @@ For this purpose, you should first suspend the listener you wish to stop gracefu </item> <item> - <title>Internals</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/internals/</link> + <title>Connection draining</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/connection_draining/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/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> + <guid>https://ninenines.eu/docs/en/ranch/2.1/guide/connection_draining/</guid> + <description>Stopping a Ranch listener via ranch:stop_listener/1 will invariably kill all connection processes the listener hosts. However, you may want to stop a listener in a graceful fashion, ie by not accepting any new connections, but allowing the existing connection processes to exit by themselves instead of being killed. +For this purpose, you should first suspend the listener you wish to stop gracefully, and then wait for its connection count to drop to zero.</description> </item> <item> @@ -1457,6 +1457,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/2.1/guide/internals/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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>Migrating from Gun 1.1 to 1.2</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1565,6 +1575,18 @@ Ranch 1.x had a bottleneck because it used only a single connection supervisor. </item> <item> + <title>Migrating from Ranch 2.0 to Ranch 2.1</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_2.0/</guid> + <description>Ranch 2.1 adds counters and alarms. +The Prometheus collector was updated to include accepted/terminated connections metrics. +Ranch 2.1 is compatible with Erlang/OTP 22.0 onward. Support for Erlang/OTP 21 has been removed. +Features added Metrics are now provided by ranch:info/0,1. Currently includes accepted/terminated connection counts per connection supervisor. Alarms can now be configured. The only alarm currently available is num_connections. When the number of connections goes over a configurable treshold Ranch will call the given callback.</description> + </item> + + <item> <title>Changes since Ranch 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1755,6 +1777,16 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> + <title>Migrating from Ranch 1.7+ to Ranch 2.0</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.7/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.7/</guid> + <description>Ranch 2.0 adds support for multiple connection supervisors. +Ranch 1.x had a bottleneck because it used only a single connection supervisor. This was more evident when many connections were dropped at once as the supervisor couldn&apos;t keep up and failed to accept new connections while cleaning up the old ones. Ranch 2.0 behaves much better in this scenario by default. Multiple connection supervisors also helps with concurrently accepting new connections.</description> + </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> @@ -1875,6 +1907,17 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.6/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.6/</guid> + <description>Ranch 1.7 adds built-in support for the PROXY protocol. +The PROXY protocol is a simple and efficient way for proxies to transmit information about the client. +While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2051,6 +2094,17 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan </item> <item> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.5/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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>Migrating from Ranch 1.x</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2207,6 +2261,16 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/migrating_from_1.x/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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>REST principles</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/rest_principles/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11329,15 +11393,6 @@ Description This chapter aims to list all HTTP status codes that Cowboy may retu <item> <title>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/</guid> - <description>ranch(7) ranch(3) ranch_protocol(3) ranch_ssl(3) ranch_tcp(3) ranch_transport(3) </description> - </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> @@ -11393,12 +11448,17 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> - <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/</link> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/guide/</guid> - <description>Introduction Listeners Transports Protocols Embedded mode Writing parsers SSL client authentication Internals </description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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&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 ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</description> </item> <item> @@ -11438,16 +11498,12 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> - <title>ranch(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch/</link> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch/</guid> - <description>Name ranch - socket acceptor pool -Description The ranch module provides functions for starting and manipulating Ranch listeners. -Types max_conns() = non_neg_integer() | infinity Maximum number of connections allowed on this listener. -This is a soft limit. The actual number of connections might be slightly above the limit due to concurrency when accepting new connections. Some connections may also be removed from this count explicitly by the user code. -opt() opt() = {ack_timeout, timeout()} | {connection_type, worker | supervisor} | {max_connections, max_conns()} | {num_acceptors, pos_integer()} | {shutdown, timeout() | brutal_kill} | {socket, any()} Ranch-specific transport options.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/guide/</guid> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Connection draining Advanced Internals Additional information Migrating from Ranch 2.0 to 2.1 Migrating from Ranch 1.7 to 2.0 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> </item> <item> @@ -11507,16 +11563,17 @@ ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3 </item> <item> - <title>ranch(7)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_app/</link> + <title>ranch(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_app/</guid> - <description>Name ranch - Socket acceptor pool for TCP protocols. -Dependencies The ranch application depends on the ssl application to start. It is used for handling secure connections, when the transport is ranch_ssl. It can be disabled if SSL is not used. -Environment The ranch application defines one application environment configuration parameter. -profile (false) When enabled, Ranch will start eprof profiling automatically. - You can use the ranch_app:profile_output/0 function to stop profiling and output the results to the files procs.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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&apos;s running state Connections: +ranch:handshake(3) - Perform the transport handshake ranch:handshake_continue(3) - Resume the paused transport handshake ranch:handshake_cancel(3) - Cancel the paused transport handshake ranch:recv_proxy_header(3) - Receive the PROXY protocol header ranch:remove_connection(3) - Remove connection from the count Options:</description> </item> <item> @@ -11576,6 +11633,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip </item> <item> + <title>ranch(7)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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&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 ranch_proxy_header(3) - PROXY protocol Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP 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> @@ -11624,6 +11695,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:child_spec(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.child_spec/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&gt; supervisor:child_spec() Build child specifications for a new listener which can be embedded directly in an application&apos;s supervision tree. +The actual listener is placed under a supervisor which monitors ranch_server via a proxy process and will restart the listener if ranch_server crashes. +Arguments Ref The listener name is used to refer to this listener in future calls, for example 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> @@ -11678,6 +11761,18 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:get_addr(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_addr/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_addr/</guid> + <description>Name ranch:get_addr - Get the listening address +Description get_addr(Ref :: ranch:ref()) -&gt; {IP :: inet:ip_address(), Port :: inet:port_number()} | {local, SocketFile :: binary()} | {undefined, undefined} Get the listening address. +Arguments Ref The listener name. + Return value The address of the listener is returned as a tuple of the form {IP, Port} when listening on a network interface, or {local, SocketFile} when listening on a UNIX Domain socket.</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> @@ -11730,6 +11825,19 @@ Changelog 2.0: The maximum number of connections is now per connection superviso </item> <item> + <title>ranch:get_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_max_connections/</guid> + <description>Name ranch:get_max_connections - Get the max number of connections per connection supervisor +Description get_max_connections(Ref :: ranch:ref()) -&gt; MaxConns :: ranch:max_conns() Get the max number of connections per connection supervisor. +Arguments Ref The listener name. + Return value The maximum number of connections per connection supervisor is returned. +Changelog 2.0: The maximum number of connections is now per connection supervisor. Examples Get the max number of connections per connection supervisor MaxConns = ranch:get_max_connections(example).</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> @@ -11786,6 +11894,20 @@ When the listener is suspended or using a UNIX Domain socket instead of a networ </item> <item> + <title>ranch:get_port(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_port/</guid> + <description>Name ranch:get_port - Get the listening port +Description get_port(Ref :: ranch:ref()) -&gt; Port :: inet:port_number() | undefined 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. +When the listener is suspended or using a UNIX Domain socket instead of a network interface, undefined will be returned.</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> @@ -11838,6 +11960,19 @@ Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options </item> <item> + <title>ranch:get_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_protocol_options/</guid> + <description>Name ranch:get_protocol_options - Get the current protocol options +Description get_protocol_options(Ref :: ranch:ref()) -&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> @@ -11890,6 +12025,19 @@ Changelog 1.6: Function introduced. Examples Get a listener&apos;s running </item> <item> + <title>ranch:get_status(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_status/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_status/</guid> + <description>Name ranch:get_status - Get a listener&apos;s running state +Description get_status(Ref :: ranch_ref()) -&gt; running | suspended Get a listener&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&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> @@ -11942,6 +12090,19 @@ Examples Get the current transport options TransOpts = ranch:get_transport_optio </item> <item> + <title>ranch:get_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.get_transport_options/</guid> + <description>Name ranch:get_transport_options - Get the current transport options +Description get_transport_options(Ref :: ranch:ref()) -&gt; TransOpts :: ranch:transport_opts(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> @@ -11986,6 +12147,17 @@ This function must be called by the protocol process in order to retrieve the so </item> <item> + <title>ranch:handshake(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake/</guid> + <description>Name ranch:handshake - Perform the transport handshake +Description handshake(Ref) -&gt; {ok, Socket} | {continue, Info} handshake(Ref, Opts) -&gt; {ok, Socket} | {continue, Info} Ref :: ranch:ref() Opts :: any() Socket :: any() Info :: 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:handshake_cancel(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12001,6 +12173,21 @@ Changelog 2.0: Function introduced. Examples Cancel a paused transport handsha </item> <item> + <title>ranch:handshake_cancel(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake_cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake_cancel/</guid> + <description>Name ranch:handshake_cancel - Cancel the paused transport handshake +Description handshake_cancel(Ref :: ranch:ref()) -&gt; ok Cancel the paused transport handshake. +This function may be called by the protocol process to cancel a paused handshake. +Arguments Ref The listener name. +Allowed options depend on the transport module. + Return value The return value depends on the transport module. +Changelog 2.0: Function introduced. Examples Cancel a paused transport handshake start_link(Ref, Transport, Opts) -&gt; Pid = proc_lib:spawn_link(?</description> + </item> + + <item> <title>ranch:handshake_continue(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake_continue/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12016,6 +12203,21 @@ Allowed options depend on the transport module. </item> <item> + <title>ranch:handshake_continue(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake_continue/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.handshake_continue/</guid> + <description>Name ranch:handshake_continue - Resume the paused transport handshake +Description handshake_continue(Ref) -&gt; {ok, Socket} handshake_continue(Ref, Opts) -&gt; {ok, Socket} Ref :: ranch:ref() Opts :: any() Socket :: any() Resume the paused transport handshake. +This function must be called by the protocol process in order to resume a paused handshake. +Arguments Ref The listener name. + Opts Transport handshake options. +Allowed options depend on the transport module. + Return value An ok tuple is returned containing the socket for the 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> @@ -12076,6 +12278,21 @@ pid Pid of the listener&apos;s top-level supervisor. </item> <item> + <title>ranch:info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.info/</guid> + <description>Name ranch:info - Overview of Ranch listeners +Description info() -&gt; #{Ref := Info} info(Ref) -&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&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> @@ -12132,6 +12349,20 @@ Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). </item> <item> + <title>ranch:procs(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.procs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.procs/</guid> + <description>Name ranch:procs - Retrieve pids from a listener +Description procs(Ref :: ranch:ref(), Type :: acceptors | connections) -&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:recv_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch.recv_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12174,6 +12405,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:recv_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.recv_proxy_header/</guid> + <description>Name ranch:recv_proxy_header - Receive the PROXY protocol header +Description recv_proxy_header(ranch:ref(), timeout()) -&gt; {ok, ranch_proxy_header:proxy_info()} | {error, Reason :: atom()} | {error, protocol_error, HumanReadable :: atom()} Receive the PROXY protocol header. +This function must be called before ranch:handshake/1,2 on newly accepted connections to read and parse the PROXY protocol header, if any. +Arguments Ref The listener name. + Timeout Receive timeout in milliseconds. + Return value An ok tuple is returned containing PROXY header information on success.</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> @@ -12222,6 +12467,18 @@ This function may only be called from a connection process.</description> </item> <item> + <title>ranch:remove_connection(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.remove_connection/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.remove_connection/</guid> + <description>Name ranch:remove_connection - Remove connection from the count +Description remove_connection(Ref :: ranch:ref()) -&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> @@ -12278,6 +12535,20 @@ Arguments Ref The listener name. </item> <item> + <title>ranch:resume_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.resume_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.resume_listener/</guid> + <description>Name ranch:resume_listener - Resume a suspended listener +Description resume_listener(Ref :: ranch_ref()) -&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> @@ -12325,6 +12596,17 @@ The change will be applied immediately. If the new value is smaller than the pre </item> <item> + <title>ranch:set_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.set_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.set_max_connections/</guid> + <description>Name ranch:set_max_connections - Set the max number of connections per connection supervisor +Description set_max_connections(Ref :: ranch:ref(), MaxConns :: ranch:max_conns()) -&gt; ok Set the max number of connections per connection supervisor. +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.</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> @@ -12385,6 +12667,18 @@ Examples Set the protocol options ranch:set_protocol_options(example, ProtoOpts) </item> <item> + <title>ranch:set_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.set_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&gt; ok Set the protocol options. +The change will be applied immediately for all new connections. Old connections will not receive the new options. +Note that the complete set of protocol options is replaced. To update a subset of the options, it is recommended to get the current protocol options using ranch:get_protocol_options(3), update them and then set them back using this function.</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> @@ -12442,6 +12736,18 @@ immediately: max_connections handshake_timeout shutdown only after the list </item> <item> + <title>ranch:set_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.set_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.set_transport_options/</guid> + <description>Name ranch:set_transport_options - Set the transport options +Description set_transport_options(Ref :: ranch:ref(), TransOpts :: ranch:opts()) -&gt; ok | {error, Reason :: term()} Set the transport options. +The complete set of transport options is replaced. To update a subset of the transport options, it is recommended to get the current transport options using ranch:get_transport_options(3), update them and then set them back using this function. +Changes to the following options will take effect.</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> @@ -12490,6 +12796,18 @@ Arguments Ref The listener name is used to refer to this listener in future call </item> <item> + <title>ranch:start_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.start_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&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> @@ -12538,6 +12856,18 @@ In order for the connection processes to exit gracefully, they need to trap exit </item> <item> + <title>ranch:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.stop_listener/</guid> + <description>Name ranch:stop_listener - Stop a listener +Description stop_listener(Ref :: ranch_ref()) -&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> @@ -12586,6 +12916,18 @@ Some transport options can only be changed when the listener is suspended. Pleas </item> <item> + <title>ranch:suspend_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.suspend_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.suspend_listener/</guid> + <description>Name ranch:suspend_listener - Suspend a running listener +Description suspend_listener(Ref :: ranch_ref()) -&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> @@ -12634,19 +12976,15 @@ This function can be used to gracefully shutdown a listener by first suspending </item> <item> - <title>ranch_protocol(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_protocol/</link> + <title>ranch:wait_for_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch.wait_for_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_protocol/</guid> - <description>Name ranch_protocol - behaviour for protocol modules -Description The ranch_protocol behaviour defines the interface used by Ranch protocols. -Types None. -Callbacks start_link(Ref, Socket, Transport, ProtoOpts) -&gt; {ok, pid()} | {ok, pid(), pid()} Ref = ranch:ref() Listener name. - Socket = any() Socket for this connection. - Transport = module() Transport module for this socket. - ProtoOpts = any() Protocol options. - Start a new connection process for the given socket.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&gt; ok Operator :: '&gt;' | '&gt;=' | '==' | '=&lt;' | '&lt;' 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> @@ -12702,6 +13040,19 @@ The only purpose of this callback is to start a process that will handle the soc </item> <item> + <title>ranch_protocol(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&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_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12735,6 +13086,17 @@ Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy </item> <item> + <title>ranch_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header/</guid> + <description>Name ranch_proxy_header - PROXY protocol +Description The module ranch_proxy_header provides functions for parsing and building the PROXY protocol header. +Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy_header:header(3) - Build a PROXY protocol header ranch_proxy_header:to_connection_info(3) - Convert proxy_info() to ssl:connection_info() Types proxy_info() proxy_info() = #{ %% Mandatory part. version := 1 | 2, command := local | proxy, transport_family =&gt; undefined | ipv4 | ipv6 | unix, transport_protocol =&gt; undefined | stream | dgram, %% Addresses.</description> + </item> + + <item> <title>ranch_proxy_header:header(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12774,6 +13136,19 @@ Arguments ProxyInfo The proxy information to encode. </item> <item> + <title>ranch_proxy_header:header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.header/</guid> + <description>Name ranch_proxy_header:header - Build a PROXY protocol header +Description header(ProxyInfo) -&gt; header(ProxyInfo, #{}) header(ProxyInfo, BuildOpts) -&gt; iodata() ProxyInfo :: ranch_proxy_header:proxy_info() BuildOpts :: #{ checksum =&gt; crc32c, padding =&gt; pos_integer() %% &gt;= 3 } Build a PROXY protocol header. +Arguments ProxyInfo The proxy information to encode. + BuildOpts Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header. + Return value The PROXY protocol header is returned.</description> + </item> + + <item> <title>ranch_proxy_header:parse(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12813,14 +13188,30 @@ An error tuple is returned when a protocol error is detected.</description> </item> <item> - <title>ranch_ssl(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_ssl/</link> + <title>ranch_proxy_header:parse(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_ssl/</guid> - <description>Name ranch_ssl - SSL transport module -Description The ranch_ssl module implements an SSL Ranch transport. -Types 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..255} | {dh, public_key:der_encoded()} | {dhfile, string()} | {fail_if_no_peer_cert, boolean()} | {hibernate_after, integer() | undefined} | {honor_cipher_order, boolean()} | {key, {'RSAPrivateKey' | 'DSAPrivateKey' | 'PrivateKeyInfo', public_key:der_encoded()}} | {keyfile, string()} | {log_alert, boolean()} | {next_protocols_advertised, [binary()]} | {padding_check, boolean()} | {partial_chain, fun(([public_key:der_encoded()]) -&gt; {trusted_ca, public_key:der_encoded()} | unknown_ca)} | {password, string()} | {psk_identity, string()} | {reuse_session, fun()} | {reuse_sessions, boolean()} | {secure_renegotiate, boolean()} | {signature_algs, [{atom(), atom()}]} | {sni_fun, fun()} | {sni_hosts, [{string(), ssl_opt()}]} | {user_lookup_fun, {fun(), any()}} | {v2_hello_compatible, boolean()} | {verify, ssl:verify_type()} | {verify_fun, {fun(), any()}} | {versions, [atom()]}.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.parse/</guid> + <description>Name ranch_proxy_header:parse - Parse a PROXY protocol header +Description parse(Data :: binary()) -&gt; {ok, ranch_proxy_header:proxy_info(), Rest :: binary()} | {error, HumanReadable :: atom()} Parse a PROXY protocol header. +Arguments Data The PROXY protocol header optionally followed by more data. + Return value An ok tuple is returned on success, containing the proxy information found in the header and the rest of the data if more was provided. +An error tuple is returned when a protocol error is detected.</description> + </item> + + <item> + <title>ranch_proxy_header:to_connection_info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_proxy_header.to_connection_info/</guid> + <description>Name ranch_proxy_header:to_connection_info - Convert proxy_info() to ssl:connection_info() +Description to_connection_info(ProxyInfo :: proxy_info()) -&gt; ssl:connection_info() Convert ranch_proxy_header:proxy_info() information to the ssl:connection_info() format returned by ssl:connection_information/1,2. +Arguments ProxyInfo The PROXY protocol information. + Return value Connection information is returned as a proplist. +Because the PROXY protocol header includes limited information, only the keys protocol, selected_cipher_suite and sni_hostname will be returned, at most. All keys are optional. +Changelog 2.1: Function introduced. Examples Convert the PROXY protocol information ConnInfo = ranch_proxy_header:to_connection_info(ProxyInfo).</description> </item> <item> @@ -12884,15 +13275,18 @@ ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {anti_replay,  </item> <item> - <title>ranch_tcp(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_tcp/</link> + <title>ranch_ssl(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_ssl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_tcp/</guid> - <description>Name ranch_tcp - TCP transport module -Description The ranch_tcp module implements a TCP Ranch transport. -Note that due to bugs in OTP up to at least R16B02, it is recommended to disable async threads when using the sendfile function of this transport, as it can make the threads stuck indefinitely. -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> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()]} | {anti_replay, '10k' | '100k' | {integer(), integer(), integer()}} | {beast_mitigation, one_n_minus_one | zero_n | disabled} | {cacertfile, file:filename()} | {cacerts, [public_key:der_encoded()]} | {cert, public_key:der_encoded()} | {certfile, file:filename()} | {ciphers, ssl:ciphers()} | {client_renegotiation, boolean()} | {crl_cache, [any()]} | {crl_check, boolean() | peer | best_effort} | {depth, integer()} | {dh, binary()} | {dhfile, file:filename()} | {eccs, [ssl:named_curve()]} | {fail_if_no_peer_cert, boolean()} | {handshake, hello | full} | {hibernate_after, timeout()} | {honor_cipher_order, boolean()} | {honor_ecc_order, boolean()} | {key, ssl:key()} | {key_update_at, pos_integer()} | {keyfile, file:filename()} | {log_alert, boolean()} | {log_level, logger:level()} | {max_handshake_size, integer()} | {middlebox_comp_mode, boolean()} | {next_protocols_advertised, [binary()]} | {padding_check, boolean()} | {partial_chain, fun()} | {password, string()} | {protocol, tls | dtls} | {psk_identity, string()} | {reuse_session, fun()} | {reuse_sessions, boolean()} | {secure_renegotiate, boolean()} | {session_tickets, disabled | stateful | stateless} | {signature_algs, [{ssl:hash(), ssl:sign_algo()}]} | {signature_algs_cert, [ssl:sign_scheme()]} | {sni_fun, fun()} | {sni_hosts, [{string(), ssl_opt()}]} | {supported_groups, [ssl:group()]} | {user_lookup_fun, {fun(), any()}} | {verify, verify_none | verify_peer} | {verify_fun, {fun(), any()}} | {versions, [ssl:protocol_version()]} SSL-specific listen options.</description> </item> <item> @@ -12948,18 +13342,16 @@ Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | </item> <item> - <title>ranch_transport(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_transport/</link> + <title>ranch_tcp(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_tcp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/ranch_transport/</guid> - <description>Name ranch_transport - behaviour for transport modules -Description The ranch_transport behaviour defines the interface used by Ranch transports. -Types sendfile_opts() = [{chunk_size, non_neg_integer()}] Options used by the sendfile function and callbacks. -Allows configuring the chunk size, in bytes. Defaults to 8191 bytes. -Callbacks accept(LSocket, Timeout) -&gt; {ok, CSocket} | {error, closed | timeout | atom()} LSocket = CSocket = any() Listening socket. - Timeout = timeout() Accept timeout. - Accept a connection on the given listening socket.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.1/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() | inet:local_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> @@ -13015,6 +13407,19 @@ close close(Socket :: socket()) -&gt; ok Close the socket.</description> </item> <item> + <title>ranch_transport(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_transport/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&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()) -&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> @@ -13062,5 +13467,17 @@ The file may be sent full or in parts, and may be specified by its filename or b This function emulates the function file:sendfile/2,4,5 and may be used when transports are not manipulating TCP directly.</description> </item> + <item> + <title>ranch_transport:sendfile(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.1/manual/ranch_transport.sendfile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/2.1/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()) -&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 |