diff options
Diffstat (limited to 'docs/index.xml')
| -rw-r--r-- | docs/index.xml | 2396 |
1 files changed, 1508 insertions, 888 deletions
diff --git a/docs/index.xml b/docs/index.xml index 60dc3cb7..a728cc0f 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.4/guide/introduction/</link> + <link>https://ninenines.eu/docs/en/ranch/1.5/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/guide/introduction/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.5/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.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. @@ -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.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. @@ -123,10 +123,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. @@ -147,17 +147,6 @@ Supported platforms Ranch is tested and supported on Linux, FreeBSD, macOS and W <item> <title>The modern Web</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/modern_web/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/modern_web/</guid> - <description>Cowboy is a server for the modern Web. This chapter explains what it means and details all the standards involved. -Cowboy supports all the standards listed in this document. -HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enables clients to keep a connection open for long periods of time; to send requests concurrently; to reduce the size of requests through HTTP headers compression; and more. The protocol is binary, greatly reducing the resources needed to parse it.</description> - </item> - - <item> - <title>The modern Web</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/modern_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -212,13 +201,14 @@ HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enab </item> <item> - <title>Erlang and the Web</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/erlang_web/</link> + <title>The modern Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/modern_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/erlang_web/</guid> - <description>Erlang is the ideal platform for writing Web applications. Its features are a perfect match for the requirements of modern Web applications. -The Web is concurrent When you access a website there is little concurrency involved. A few connections are opened and requests are sent through these connections. Then the web page is displayed on your screen. Your browser will only open up to 4 or 8 connections to the server, depending on your settings.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/modern_web/</guid> + <description>Cowboy is a server for the modern Web. This chapter explains what it means and details all the standards involved. +Cowboy supports all the standards listed in this document. +HTTP/2 HTTP/2 is the most efficient protocol for consuming Web services. It enables clients to keep a connection open for long periods of time; to send requests concurrently; to reduce the size of requests through HTTP headers compression; and more. The protocol is binary, greatly reducing the resources needed to parse it.</description> </item> <item> @@ -272,13 +262,13 @@ The Web is concurrent When you access a website there is little concurrency invo </item> <item> - <title>Listeners</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/guide/listeners/</link> + <title>Erlang and the Web</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/erlang_web/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/erlang_web/</guid> + <description>Erlang is the ideal platform for writing Web applications. Its features are a perfect match for the requirements of modern Web applications. +The Web is concurrent When you access a website there is little concurrency involved. A few connections are opened and requests are sent through these connections. Then the web page is displayed on your screen. Your browser will only open up to 4 or 8 connections to the server, depending on your settings.</description> </item> <item> @@ -313,6 +303,16 @@ The listener takes care of supervising all the acceptor and connection processes <item> <title>Listeners</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/listeners/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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/2.0/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -443,18 +443,6 @@ Gun will send a gun_inform message for every intermediate informational response <item> <title>Introduction</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/introduction/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/introduction/</guid> - <description>Cowboy is a small, fast and modern HTTP server for Erlang/OTP. -Cowboy aims to provide a complete modern Web stack. This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and Webmachine-based REST. -Cowboy comes with functions for introspection and tracing, enabling developers to know precisely what is happening at any time. Its modular design also easily enable developers to add instrumentation. -Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded in another application.</description> - </item> - - <item> - <title>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -514,16 +502,15 @@ Cowboy is a high quality project. It has a small code base, is very efficient (b </item> <item> - <title>Transports</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/guide/transports/</link> + <title>Introduction</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/introduction/</guid> + <description>Cowboy is a small, fast and modern HTTP server for Erlang/OTP. +Cowboy aims to provide a complete modern Web stack. This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and Webmachine-based REST. +Cowboy comes with functions for introspection and tracing, enabling developers to know precisely what is happening at any time. Its modular design also easily enable developers to add instrumentation. +Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded in another application.</description> </item> <item> @@ -567,6 +554,19 @@ 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> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <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. +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>Transports</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/transports/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -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.4/guide/protocols/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.5/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -675,22 +665,22 @@ Writing a protocol handler All protocol handlers must implement the ranch_protoc <item> <title>Protocols</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/protocols/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/protocols/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> +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.3/guide/getting_started/</link> + <title>Protocols</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/getting_started/</guid> - <description>Erlang is more than a language, it is also an operating system for your applications. Erlang developers rarely write standalone modules, they write libraries or applications, and then bundle those into what is called a release. A release contains the Erlang VM plus all applications required to run the node, so it can be pushed to production directly. -This chapter walks you through all the steps of setting up Cowboy, writing your first application and generating your first release.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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> @@ -744,6 +734,16 @@ This chapter walks you through all the steps of setting up Cowboy, writing your </item> <item> + <title>Getting started</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/getting_started/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/getting_started/</guid> + <description>Erlang is more than a language, it is also an operating system for your applications. Erlang developers rarely write standalone modules, they write libraries or applications, and then bundle those into what is called a release. A release contains the Erlang VM plus all applications required to run the node, so it can be pushed to production directly. +This chapter walks you through all the steps of setting up Cowboy, writing your first application and generating your first release.</description> + </item> + + <item> <title>HTTP</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/http/</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.4/guide/embedded/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.5/guide/embedded/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -845,24 +835,22 @@ Embedding To embed Ranch in your application you can simply add the child specs <item> <title>Embedded mode</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/embedded/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/embedded/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/embedded/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> +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>Flow diagram</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/flow_diagram/</link> + <title>Embedded mode</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/embedded/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/flow_diagram/</guid> - <description>Cowboy is a lightweight HTTP server with support for HTTP/1.1, HTTP/2 and Websocket. -It is built on top of Ranch. Please see the Ranch guide for more information about how the network connections are handled. -Overview As you can see on the diagram, the client begins by connecting to the server. This step is handled by a Ranch acceptor, which is a process dedicated to accepting new connections. -After Ranch accepts a new connection, whether it is an HTTP/1.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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> @@ -926,6 +914,18 @@ After Ranch accepts a new connection, whether it is an HTTP/1.</description> </item> <item> + <title>Flow diagram</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/flow_diagram/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/flow_diagram/</guid> + <description>Cowboy is a lightweight HTTP server with support for HTTP/1.1, HTTP/2 and Websocket. +It is built on top of Ranch. Please see the Ranch guide for more information about how the network connections are handled. +Overview As you can see on the diagram, the client begins by connecting to the server. This step is handled by a Ranch acceptor, which is a process dedicated to accepting new connections. +After Ranch accepts a new connection, whether it is an HTTP/1.</description> + </item> + + <item> <title>Websocket</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/websocket/</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.4/guide/parsers/</link> + <link>https://ninenines.eu/docs/en/ranch/1.5/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/guide/parsers/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.5/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.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> @@ -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.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> @@ -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.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> @@ -1078,17 +1078,6 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t <item> <title>Listeners</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/listeners/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/listeners/</guid> - <description>A listener is a set of processes that listens on a port for new connections. Incoming connections get handled by Cowboy. Depending on the connection handshake, one or another protocol may be used. -This chapter is specific to Cowboy. Please refer to the Ranch User Guide for more information about listeners. -Cowboy provides two types of listeners: one listening for clear TCP connections, and one listening for secure TLS connections. Both of them support the HTTP/1.</description> - </item> - - <item> - <title>Listeners</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1143,13 +1132,14 @@ Cowboy provides two types of listeners: one listening for clear TCP connections, </item> <item> - <title>SSL client authentication</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/guide/ssl_auth/</link> + <title>Listeners</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/listeners/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/listeners/</guid> + <description>A listener is a set of processes that listens on a port for new connections. Incoming connections get handled by Cowboy. Depending on the connection handshake, one or another protocol may be used. +This chapter is specific to Cowboy. Please refer to the Ranch User Guide for more information about listeners. +Cowboy provides two types of listeners: one listening for clear TCP connections, and one listening for secure TLS connections. Both of them support the HTTP/1.</description> </item> <item> @@ -1184,24 +1174,22 @@ The server only needs to retain the certificate serial number and the certificat <item> <title>SSL client authentication</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/ssl_auth/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/ssl_auth/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/guide/ssl_auth/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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>Routing</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/routing/</link> + <title>SSL client authentication</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/ssl_auth/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/routing/</guid> - <description>Cowboy does nothing by default. -To make Cowboy useful, you need to map URIs to Erlang modules that will handle the requests. This is called routing. -When Cowboy receives a request, it tries to match the requested host and path to the configured routes. When there&apos;s a match, the route&apos;s associated handler is executed. -Routes need to be compiled before they can be used by Cowboy. The result of the compilation is the dispatch rules.</description> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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> @@ -1265,6 +1253,18 @@ If no configured host matches the request URI, a 400 response is returned. Othe </item> <item> + <title>Routing</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/routing/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/routing/</guid> + <description>Cowboy does nothing by default. +To make Cowboy useful, you need to map URIs to Erlang modules that will handle the requests. This is called routing. +Cowboy routes requests using the following algorithm: +If no configured host matches the request URI, a 400 response is returned. Otherwise, the first configured host that matches the request URI will be used. Only the paths configured for this host will be considered. If none of the configured paths found in the previous step match the request URI, a 404 response is returned.</description> + </item> + + <item> <title>Connection draining</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/connection_draining/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1276,40 +1276,40 @@ For this purpose, you should first suspend the listener you wish to stop gracefu <item> <title>Internals</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/guide/internals/</link> + <link>https://ninenines.eu/docs/en/ranch/1.5/guide/internals/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/guide/internals/</guid> + <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> </item> <item> <title>Internals</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/internals/</link> + <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.5/guide/internals/</guid> + <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>Internals</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/internals/</link> + <link>https://ninenines.eu/docs/en/ranch/1.7/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> + <guid>https://ninenines.eu/docs/en/ranch/1.7/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>Internals</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/internals/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/internals/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/internals/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> @@ -1346,18 +1346,6 @@ Gun 2.0 adds many more features such as Websocket over HTTP/2, a built-in cookie <item> <title>Constraints</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/constraints/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/constraints/</guid> - <description>Constraints are validation and conversion functions applied to user input. -They are used in various places in Cowboy, including the router and the cowboy_req match functions. -Syntax Constraints are provided as a list of fields. For each field in the list, specific constraints can be applied, as well as a default value if the field is missing. -A field can take the form of an atom field, a tuple with constraints {field, Constraints} or a tuple with constraints and a default value {field, Constraints, Default}.</description> - </item> - - <item> - <title>Constraints</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1417,6 +1405,18 @@ A field can take the form of an atom field, a tuple with constraints {field, Con </item> <item> + <title>Constraints</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/constraints/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/constraints/</guid> + <description>Constraints are validation and conversion functions applied to user input. +They are used in various places in Cowboy, including the router and the cowboy_req match functions. +Syntax Constraints are provided as a list of fields. For each field in the list, specific constraints can be applied, as well as a default value if the field is missing. +A field can take the form of an atom field, a tuple with constraints {field, Constraints} or a tuple with constraints and a default value {field, Constraints, Default}.</description> + </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> @@ -1437,6 +1437,16 @@ The function ranch:start_listener/6 has been deprecated in favor of ranch:start_ </item> <item> + <title>Upcoming changes in Ranch 2.0</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/upcoming_2.0_changes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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&apos;s information rather than a list of key/values.</description> + </item> + + <item> <title>Internals</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/internals/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1458,10 +1468,10 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.4/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1471,10 +1481,10 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.5/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.4/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.5/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1484,10 +1494,10 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.5/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.5/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1497,10 +1507,10 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.7/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.7/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1510,10 +1520,10 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.7/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.7/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.8/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1523,10 +1533,10 @@ init(Req, State) -&gt; {ok, Req, State}. Despite sending no reply, a 204 No <item> <title>Handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/handlers/</link> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.8/guide/handlers/</guid> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/handlers/</guid> <description>Handlers are Erlang modules that handle HTTP requests. Plain HTTP handlers The most basic handler in Cowboy implements the mandatory init/2 callback, manipulates the request, optionally sends a response and then returns. This callback receives the Req object and the initial state defined in the router configuration. @@ -1577,13 +1587,14 @@ Because the plain crc32 checksum is not supported by the PROXY protocol, the con </item> <item> - <title>Loop handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/loop_handlers/</link> + <title>Migrating from Ranch 1.7 to 1.8</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/loop_handlers/</guid> - <description>Loop handlers are a special kind of HTTP handlers used when the response can not be sent right away. The handler enters instead a receive loop waiting for the right message before it can send a response. -Loop handlers are used for requests where a response might not be immediately available, but where you would like to keep the connection open for a while in case the response arrives. The most known example of such practice is known as long polling.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.7/</guid> + <description>Ranch 1.8 is a compatibility update for Erlang/OTP 24. +Ranch 1.8 is compatible with Erlang/OTP 21.0 onward. Support for Erlang/OTP 19 and 20 has been removed. +Bugs fixed An issue with the PROXY protocol was fixed in Ranch 1.7.1. The wrong CRC32 algorithm was used and would cause checksum verification to fail when used. The configuration value when building PROXY headers has been changed to crc32c to reflect the correct algorithm.</description> </item> <item> @@ -1637,6 +1648,16 @@ Loop handlers are used for requests where a response might not be immediately av </item> <item> + <title>Loop handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/loop_handlers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/loop_handlers/</guid> + <description>Loop handlers are a special kind of HTTP handlers used when the response can not be sent right away. The handler enters instead a receive loop waiting for the right message before it can send a response. +Loop handlers are used for requests where a response might not be immediately available, but where you would like to keep the connection open for a while in case the response arrives. The most known example of such practice is known as long polling.</description> + </item> + + <item> <title>Migrating from Gun 1.0 to 1.1</title> <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1658,17 +1679,6 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t <item> <title>Static files</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/static_files/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/static_files/</guid> - <description>Cowboy comes with a ready to use handler for serving static files. It is provided as a convenience for serving files during development. -For systems in production, consider using one of the many Content Distribution Network (CDN) available on the market, as they are the best solution for serving files. -The static handler can serve either one file or all files from a given directory. The etag generation and mime types can be configured.</description> - </item> - - <item> - <title>Static files</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/static_files/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1723,6 +1733,17 @@ The static handler can serve either one file or all files from a given directory </item> <item> + <title>Static files</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/static_files/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/static_files/</guid> + <description>Cowboy comes with a ready to use handler for serving static files. It is provided as a convenience for serving files during development. +For systems in production, consider using one of the many Content Distribution Network (CDN) available on the market, as they are the best solution for serving files. +The static handler can serve either one file or all files from a given directory. The etag generation and mime types can be configured.</description> + </item> + + <item> <title>Migrating from Ranch 1.6 to 1.7</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1756,24 +1777,24 @@ While a third-party library already existed, it was not entirely compatible with </item> <item> - <title>Migrating from Gun 1.0 to 1.1</title> - <link>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.0/</link> + <title>Migrating from Ranch 1.6 to 1.7</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.0/</guid> - <description>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features. -Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun_sse_h where lone id lines were not propagated has been fixed by updating the Cowlib dependency. The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended.</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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>The Req object</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/req/</link> + <title>Migrating from Gun 1.0 to 1.1</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/req/</guid> - <description>The Req object is a variable used for obtaining information about a request, read its body or send a response. -It is not really an object in the object-oriented sense. It is a simple map that can be directly accessed or used when calling functions from the cowboy_req module. -The Req object is the subject of a few different chapters. In this chapter we will learn about the Req object and look at how to retrieve information about the request.</description> + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.0/</guid> + <description>Gun 1.1 updates the Cowlib dependency to 2.5.1 and fixes a few problems with experimental features. +Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun_sse_h where lone id lines were not propagated has been fixed by updating the Cowlib dependency. The status code was incorrectly given to the experimental content handlers as a binary. It has been fixed an an integer is now given as was intended.</description> </item> <item> @@ -1832,6 +1853,17 @@ The Req object is the subject of a few different chapters. In this chapter we wi </item> <item> + <title>The Req object</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/req/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/req/</guid> + <description>The Req object is a variable used for obtaining information about a request, read its body or send a response. +It is not really an object in the object-oriented sense. It is a simple map that can be directly accessed or used when calling functions from the cowboy_req module. +The Req object is the subject of a few different chapters. In this chapter we will learn about the Req object and look at how to retrieve information about the request.</description> + </item> + + <item> <title>Migrating from Ranch 1.5 to 1.6</title> <link>https://ninenines.eu/docs/en/ranch/2.0/guide/migrating_from_1.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -1854,25 +1886,24 @@ Features added Listeners can now be suspended/resumed without stopping existing </item> <item> - <title>Migrating from Ranch 1.x</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</link> + <title>Migrating from Ranch 1.5 to 1.6</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/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.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> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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>Reading the request body</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/req_body/</link> + <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/cowboy/2.3/guide/req_body/</guid> - <description>The request body can be read using the Req object. -Cowboy will not attempt to read the body until requested. You need to call the body reading functions in order to retrieve it. -Cowboy will not cache the body, it is therefore only possible to read it once. -You are not required to read it, however. If a body is present and was not read, Cowboy will either cancel or skip its download, depending on the protocol.</description> + <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> @@ -1936,15 +1967,15 @@ You are not required to read it, however. If a body is present and was not read, </item> <item> - <title>Sending a response</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/resp/</link> + <title>Reading the request body</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/req_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/resp/</guid> - <description>The response must be sent using the Req object. -Cowboy provides two different ways of sending responses: either directly or by streaming the body. Response headers and body may be set in advance. The response is sent as soon as one of the reply or stream reply function is called. -Cowboy also provides a simplified interface for sending files. It can also send only specific parts of a file. -While only one response is allowed for every request, HTTP/2 introduced a mechanism that allows the server to push additional resources related to the response.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/req_body/</guid> + <description>The request body can be read using the Req object. +Cowboy will not attempt to read the body until requested. You need to call the body reading functions in order to retrieve it. +Cowboy will not cache the body, it is therefore only possible to read it once. +You are not required to read it, however. If a body is present and was not read, Cowboy will either cancel or skip its download, depending on the protocol.</description> </item> <item> @@ -2008,6 +2039,18 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan </item> <item> + <title>Sending a response</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/resp/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/resp/</guid> + <description>The response must be sent using the Req object. +Cowboy provides two different ways of sending responses: either directly or by streaming the body. Response headers and body may be set in advance. The response is sent as soon as one of the reply or stream reply function is called. +Cowboy also provides a simplified interface for sending files. It can also send only specific parts of a file. +While only one response is allowed for every request, HTTP/2 introduced a mechanism that allows the server to push additional resources related to the response.</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> @@ -2028,13 +2071,13 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan </item> <item> - <title>Using cookies</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/cookies/</link> + <title>Migrating from Ranch 1.x</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/migrating_from_1.x/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/cookies/</guid> - <description>Cookies are a mechanism allowing applications to maintain state on top of the stateless HTTP protocol. -Cookies are a name/value store where the names and values are stored in plain text. They expire either after a delay or when the browser closes. They can be configured on a specific domain name or path, and restricted to secure resources (sent or downloaded over HTTPS), or restricted to the server (disallowing access from client-side scripts).</description> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> @@ -2088,14 +2131,13 @@ Cookies are a name/value store where the names and values are stored in plain te </item> <item> - <title>Multipart requests</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/multipart/</link> + <title>Using cookies</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/multipart/</guid> - <description>Multipart originates from MIME, an Internet standard that extends the format of emails. -A multipart message is a list of parts. A part contains headers and a body. The body of the parts may be of any media type, and contain text or binary data. It is possible for parts to contain a multipart media type. -In the context of HTTP, multipart is most often used with the multipart/form-data media type.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/cookies/</guid> + <description>Cookies are a mechanism allowing applications to maintain state on top of the stateless HTTP protocol. +Cookies are a name/value store where the names and values are stored in plain text. They expire either after a delay or when the browser closes. They can be configured on a specific domain name or path, and restricted to secure resources (sent or downloaded over HTTPS), or restricted to the server (disallowing access from client-side scripts).</description> </item> <item> @@ -2154,14 +2196,14 @@ In the context of HTTP, multipart is most often used with the multipart/form-dat </item> <item> - <title>REST principles</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_principles/</link> + <title>Multipart requests</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/multipart/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_principles/</guid> - <description>This chapter will attempt to define the concepts behind REST and explain what makes a service RESTful. -REST is often confused with performing a distinct operation depending on the HTTP method, while using more than the GET and POST methods. That&apos;s highly misguided at best. -We will first attempt to define REST and will look at what it means in the context of HTTP and the Web. For a more in-depth explanation of REST, you can read Roy T.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/multipart/</guid> + <description>Multipart originates from MIME, an Internet standard that extends the format of emails. +A multipart message is a list of parts. A part contains headers and a body. The body of the parts may be of any media type, and contain text or binary data. It is possible for parts to contain a multipart media type. +In the context of HTTP, multipart is most often used with the multipart/form-data media type.</description> </item> <item> @@ -2220,15 +2262,14 @@ We will first attempt to define REST and will look at what it means in the conte </item> <item> - <title>REST handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_handlers/</link> + <title>REST principles</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_principles/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_handlers/</guid> - <description>REST is implemented in Cowboy as a sub protocol. The request is handled as a state machine with many optional callbacks describing the resource and modifying the machine&apos;s behavior. -The REST handler is the recommended way to handle HTTP requests. -Initialization First, the init/2 callback is called. This callback is common to all handlers. To use REST for the current request, this function must return a cowboy_rest tuple. -init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_principles/</guid> + <description>This chapter will attempt to define the concepts behind REST and explain what makes a service RESTful. +REST is often confused with performing a distinct operation depending on the HTTP method, while using more than the GET and POST methods. That&apos;s highly misguided at best. +We will first attempt to define REST and will look at what it means in the context of HTTP and the Web. For a more in-depth explanation of REST, you can read Roy T.</description> </item> <item> @@ -2292,14 +2333,15 @@ init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> </item> <item> - <title>REST flowcharts</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_flowcharts/</link> + <title>REST handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/rest_flowcharts/</guid> - <description>This chapter will explain the REST handler state machine through a number of different diagrams. -There are four main paths that requests may follow. One for the method OPTIONS; one for the methods GET and HEAD; one for the methods PUT, POST and PATCH; and one for the method DELETE. -All paths start with the &quot;Start&quot; diagram, and all paths excluding the OPTIONS path go through the &quot;Content negotiation&quot; diagram and optionally the &quot;Conditional requests&quot; diagram if the resource exists.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_handlers/</guid> + <description>REST is implemented in Cowboy as a sub protocol. The request is handled as a state machine with many optional callbacks describing the resource and modifying the machine&apos;s behavior. +The REST handler is the recommended way to handle HTTP requests. +Initialization First, the init/2 callback is called. This callback is common to all handlers. To use REST for the current request, this function must return a cowboy_rest tuple. +init(Req, State) -&gt; {cowboy_rest, Req, State}.</description> </item> <item> @@ -2358,13 +2400,14 @@ All paths start with the &quot;Start&quot; diagram, and all paths exclud </item> <item> - <title>Designing a resource handler</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/resource_design/</link> + <title>REST flowcharts</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_flowcharts/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/resource_design/</guid> - <description>This chapter aims to provide you with a list of questions you must answer in order to write a good resource handler. It is meant to be usable as a step by step guide. -The service Can the service become unavailable, and when it does, can we detect it? For example, database connectivity problems may be detected early. We may also have planned outages of all or parts of the system.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/rest_flowcharts/</guid> + <description>This chapter will explain the REST handler state machine through a number of different diagrams. +There are four main paths that requests may follow. One for the method OPTIONS; one for the methods GET and HEAD; one for the methods PUT, POST and PATCH; and one for the method DELETE. +All paths start with the &quot;Start&quot; diagram, and all paths excluding the OPTIONS path go through the &quot;Content negotiation&quot; diagram and optionally the &quot;Conditional requests&quot; diagram if the resource exists.</description> </item> <item> @@ -2418,14 +2461,13 @@ The service Can the service become unavailable, and when it does, can we detect </item> <item> - <title>The Websocket protocol</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/ws_protocol/</link> + <title>Designing a resource handler</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/resource_design/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/ws_protocol/</guid> - <description>This chapter explains what Websocket is and why it is a vital component of soft realtime Web applications. -Description Websocket is an extension to HTTP that emulates plain TCP connections between the client, typically a Web browser, and the server. It uses the HTTP Upgrade mechanism to establish the connection. -Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and HTTP/2 (asynchronous, but the server can only initiate streams in response to requests).</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/resource_design/</guid> + <description>This chapter aims to provide you with a list of questions you must answer in order to write a good resource handler. It is meant to be usable as a step by step guide. +The service Can the service become unavailable, and when it does, can we detect it? For example, database connectivity problems may be detected early. We may also have planned outages of all or parts of the system.</description> </item> <item> @@ -2484,13 +2526,14 @@ Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and </item> <item> - <title>Websocket handlers</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/ws_handlers/</link> + <title>The Websocket protocol</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/ws_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/ws_handlers/</guid> - <description>Websocket handlers provide an interface for upgrading HTTP/1.1 connections to Websocket and sending or receiving frames on the Websocket connection. -As Websocket connections are established through the HTTP/1.1 upgrade mechanism, Websocket handlers need to be able to first receive the HTTP request for the upgrade, before switching to Websocket and taking over the connection. They can then receive or send Websocket frames, handle incoming Erlang messages or close the connection.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/ws_protocol/</guid> + <description>This chapter explains what Websocket is and why it is a vital component of soft realtime Web applications. +Description Websocket is an extension to HTTP that emulates plain TCP connections between the client, typically a Web browser, and the server. It uses the HTTP Upgrade mechanism to establish the connection. +Websocket connections are fully asynchronous, unlike HTTP/1.1 (synchronous) and HTTP/2 (asynchronous, but the server can only initiate streams in response to requests).</description> </item> <item> @@ -2544,14 +2587,13 @@ As Websocket connections are established through the HTTP/1.1 upgrade mechanism, </item> <item> - <title>Streams</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/streams/</link> + <title>Websocket handlers</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/ws_handlers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/streams/</guid> - <description>A stream is the set of messages that form an HTTP request/response pair. -The term stream comes from HTTP/2. In Cowboy, it is also used when talking about HTTP/1.1 or HTTP/1.0. It should not be confused with streaming the request or response body. -All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one also allowing servers, through its server push feature. Both client and server-initiated streams go through the same process in Cowboy.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/ws_handlers/</guid> + <description>Websocket handlers provide an interface for upgrading HTTP/1.1 connections to Websocket and sending or receiving frames on the Websocket connection. +As Websocket connections are established through the HTTP/1.1 upgrade mechanism, Websocket handlers need to be able to first receive the HTTP request for the upgrade, before switching to Websocket and taking over the connection. They can then receive or send Websocket frames, handle incoming Erlang messages or close the connection.</description> </item> <item> @@ -2610,14 +2652,14 @@ All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one a </item> <item> - <title>Middlewares</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/middlewares/</link> + <title>Streams</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/streams/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/middlewares/</guid> - <description>Cowboy delegates the request processing to middleware components. By default, two middlewares are defined, for the routing and handling of the request, as is detailed in most of this guide. -Middlewares give you complete control over how requests are to be processed. You can add your own middlewares to the mix or completely change the chain of middlewares as needed. -Cowboy will execute all middlewares in the given order, unless one of them decides to stop processing.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/streams/</guid> + <description>A stream is the set of messages that form an HTTP request/response pair. +The term stream comes from HTTP/2. In Cowboy, it is also used when talking about HTTP/1.1 or HTTP/1.0. It should not be confused with streaming the request or response body. +All versions of HTTP allow clients to initiate streams. HTTP/2 is the only one also allowing servers, through its server push feature. Both client and server-initiated streams go through the same process in Cowboy.</description> </item> <item> @@ -2676,6 +2718,17 @@ Cowboy will execute all middlewares in the given order, unless one of them decid </item> <item> + <title>Middlewares</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/middlewares/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/middlewares/</guid> + <description>Cowboy delegates the request processing to middleware components. By default, two middlewares are defined, for the routing and handling of the request, as is detailed in most of this guide. +Middlewares give you complete control over how requests are to be processed. You can add your own middlewares to the mix or completely change the chain of middlewares as needed. +Cowboy will execute all middlewares in the given order, unless one of them decides to stop processing.</description> + </item> + + <item> <title>Changes since Cowboy 2.6</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2689,16 +2742,6 @@ Cowboy will now use the host header when the HTTP/2 :authority pseudo header is </item> <item> - <title>Migrating from Cowboy 2.2 to 2.3</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.2/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.2/</guid> - <description>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions. -Features added Add support for all functions from the module sys. Note that Cowboy currently does not implement the sys debugging mechanisms as tracing is recommended instead. Add a max_frame_size option for Websocket handlers to close the connection when the client attempts to send a frame that&apos;s too large.</description> - </item> - - <item> <title>Migrating from Cowboy 2.3 to 2.4</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/migrating_from_2.3/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2738,6 +2781,16 @@ One process per connection The first version of Cowboy featured a single process </item> <item> + <title>Performance</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/performance/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/performance/</guid> + <description>This chapter describes the performance characteristics of Cowboy and offers suggestions to get the most performance out of your application. +One process per connection The first version of Cowboy featured a single process per connection, whereas the current version of Cowboy features one process per connection plus one process per request. This has a negative impact on performance, but is necessary in order to provide a common interface for both HTTP/1.</description> + </item> + + <item> <title>Migrating from Cowboy 2.7 to 2.8</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/migrating_from_2.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2748,13 +2801,14 @@ Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is t </item> <item> - <title>Migrating from Cowboy 2.1 to 2.2</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.1/</link> + <title>Migrating from Cowboy 2.8 to 2.9</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.8/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.1/</guid> - <description>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way. -Features added Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.8/</guid> + <description>Cowboy 2.9 implements graceful shutdown of connection processes for both HTTP/1.1 and HTTP/2 connections. +Cowboy 2.9 is the first release to support the much awaited Erlang/OTP 24 out of the box. While users that were using Ranch 2.0 already were ready for OTP 24, the Ranch version used by Cowboy out of the box was not compatible and had to be updated. +Cowboy 2.9 also contains a small number of tweaks and bug fixes.</description> </item> <item> @@ -2809,13 +2863,13 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> - <title>Migrating from Cowboy 2.0 to 2.1</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.0/</link> + <title>Migrating from Cowboy 2.7 to 2.8</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.7/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_2.0/</guid> - <description>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed. -Features added It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object. Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response. The expect: 100-continue header is now handled automatically.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.7/</guid> + <description>Cowboy 2.8 contains many optimizations for all protocols. HTTP/1.1 has received the largest improvements and Cowboy will now be able to handle noticeably more requests. Thanks to the folks at Stressgrid for helping identify that the performance was lower than it should have been and for benchmarking my many changes and experiments. +Cowboy 2.8 also contains a small number of tweaks and bug fixes. Cowboy 2.8 is the first Cowboy release, ever, to be consistently green on all tested platforms.</description> </item> <item> @@ -2870,14 +2924,12 @@ Features added Add support for the PROXY protocol header. It can be enabled via </item> <item> - <title>Migrating from Cowboy 1.0 to 2.0</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_1.0/</link> + <title>Migrating from Cowboy 2.6 to 2.7</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.6/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/migrating_from_1.0/</guid> - <description>A lot has changed between Cowboy 1.0 and 2.0. The cowboy_req interface in particular has seen a massive revamp. Hooks are gone, their functionality can now be achieved via stream handlers. -The documentation has seen great work, in particular the manual. Each module and each function now has its own dedicated manual page with full details and examples. -Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erlang/OTP 19.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.6/</guid> + <description>Cowboy 2.7 improves the HTTP/2 code with optimizations around the sending of DATA and WINDOW_UPDATE frames; graceful shutdown of the connection when the client is going away; and rate limiting mechanisms. New options and mechanisms have also been added to control the amount of memory Cowboy ends up using with both HTTP/1.1 and HTTP/2. Much, but not all, of this work was done to address HTTP/2 CVEs about potential denial of service.</description> </item> <item> @@ -2931,13 +2983,14 @@ Features added Add option linger_timeout to control how long Cowboy will wait be </item> <item> - <title>HTTP and other specifications</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/specs/</link> + <title>Migrating from Cowboy 2.5 to 2.6</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.5/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/specs/</guid> - <description>This chapter intends to list all the specification documents for or related to HTTP. -HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message Headers HTTP Parameters HTTP Alt-Svc Parameter Registry HTTP Authentication Scheme Registry HTTP Cache Directive Registry HTTP Digest Algorithm Values HTTP Origin-Bound Authentication Device Identifier Types HTTP Upgrade Token Registry HTTP Warn Codes HTTP/2 Parameters WebSocket Protocol Registries Current CORS: Cross-Origin Resource Sharing CSP2: Content Security Policy Level 2 DNT: Tracking Preference Expression (DNT) eventsource: Server-Sent Events Form content types: Form content types Preload: Preload PROXY: The PROXY protocol REST: Fielding&apos;s Dissertation RFC 1945: HTTP/1.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.5/</guid> + <description>Cowboy 2.6 greatly refactored the HTTP/2 code, a large part of which was moved to Cowlib and is now used by both the Cowboy server and the Gun client. +A large number of tickets were also closed which resulted in many bugs fixed and many features and options added, although some of them are still experimental. +Features added Add support for the PROXY protocol header. It can be enabled via the proxy_header option.</description> </item> <item> @@ -2992,6 +3045,16 @@ Features added Add experimental support for Websocket over HTTP/2. You can use t </item> <item> + <title>Migrating from Cowboy 2.4 to 2.5</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.4/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.4/</guid> + <description>Cowboy 2.5 focused on making the test suites pass. A variety of new features, fixes and improvements have also been worked on. +Features added Add option linger_timeout to control how long Cowboy will wait before closing the socket when shutting down the connection. This helps avoid the TCP reset problem HTTP/1.1 suffers from. The default is now 1000 ms. It is now possible to stream a response body without using chunked transfer-encoding when the protocol is HTTP/1.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3043,6 +3106,16 @@ Features added Add support for all functions from the module sys. Note that Cowb </item> <item> + <title>Migrating from Cowboy 2.3 to 2.4</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.3/</guid> + <description>Cowboy 2.4 focused on improving the HTTP/2 implementation. All existing tests from RFC7540 and the h2spec test suite now all pass. Numerous options have been added to control SETTINGS and related behavior. In addition experimental support for Websocket over HTTP/2 was added. +Features added Add experimental support for Websocket over HTTP/2. You can use the enable_connect_protocol option to enable. It implements the following draft: https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01 Add options max_decode_table_size and max_encode_table_size to restrict the size of the HPACK compression dictionary.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3083,6 +3156,16 @@ Features added Add support for sending trailers at the end of response bodies. T </item> <item> + <title>Migrating from Cowboy 2.2 to 2.3</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.2/</guid> + <description>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions. +Features added Add support for all functions from the module sys. Note that Cowboy currently does not implement the sys debugging mechanisms as tracing is recommended instead. Add a max_frame_size option for Websocket handlers to close the connection when the client attempts to send a frame that&apos;s too large.</description> + </item> + + <item> <title>Migrating from Cowboy 1.0 to 2.0</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3115,6 +3198,16 @@ Features added It is now possible to obtain the client TLS certificate and the l </item> <item> + <title>Migrating from Cowboy 2.1 to 2.2</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.1/</guid> + <description>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way. +Features added Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3146,6 +3239,16 @@ Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erl </item> <item> + <title>Migrating from Cowboy 2.0 to 2.1</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_2.0/</guid> + <description>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed. +Features added It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object. Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response. The expect: 100-continue header is now handled automatically.</description> + </item> + + <item> <title>HTTP and other specifications</title> <link>https://ninenines.eu/docs/en/cowboy/2.8/guide/specs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3156,6 +3259,27 @@ HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message He </item> <item> + <title>Migrating from Cowboy 1.0 to 2.0</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_1.0/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/migrating_from_1.0/</guid> + <description>A lot has changed between Cowboy 1.0 and 2.0. The cowboy_req interface in particular has seen a massive revamp. Hooks are gone, their functionality can now be achieved via stream handlers. +The documentation has seen great work, in particular the manual. Each module and each function now has its own dedicated manual page with full details and examples. +Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erlang/OTP 19.</description> + </item> + + <item> + <title>HTTP and other specifications</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/specs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/specs/</guid> + <description>This chapter intends to list all the specification documents for or related to HTTP. +HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message Headers HTTP Parameters HTTP Alt-Svc Parameter Registry HTTP Authentication Scheme Registry HTTP Cache Directive Registry HTTP Digest Algorithm Values HTTP Origin-Bound Authentication Device Identifier Types HTTP Upgrade Token Registry HTTP Warn Codes HTTP/2 Parameters WebSocket Protocol Registries Current CORS: Cross-Origin Resource Sharing CSP2: Content Security Policy Level 2 DNT: Tracking Preference Expression (DNT) eventsource: Server-Sent Events Form content types: Form content types Preload: Preload PROXY: The PROXY protocol REST: Fielding&apos;s Dissertation RFC 1945: HTTP/1.</description> + </item> + + <item> <title>cow_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.10/manual/cow_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3168,6 +3292,17 @@ Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set <item> <title>cow_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie/</guid> + <description>Name cow_cookie - Cookies +Description The module cow_cookie provides functions for parsing and manipulating cookie headers. +Exports cow_cookie:parse_cookie(3) - Parse a cookie header cow_cookie:parse_set_cookie(3) - Parse a set-cookie header cow_cookie:cookie(3) - Generate a cookie header cow_cookie:setcookie(3) - Generate a set-cookie header Types cookie_attrs() cookie_attrs() :: #{ expires =&gt; calendar:datetime(), max_age =&gt; calendar:datetime(), domain =&gt; binary(), path =&gt; binary(), secure =&gt; true, http_only =&gt; true, same_site =&gt; strict | lax | none } Cookie attributes parsed from the set-cookie header.</description> + </item> + + <item> + <title>cow_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3203,6 +3338,19 @@ Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = <item> <title>cow_cookie:cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.cookie/</guid> + <description>Name cow_cookie:cookie - Generate a cookie header +Description cookie(Cookies) -&gt; iolist() Cookies :: [{Name :: iodata(), Value :: iodata()}] Generate a cookie header. +Arguments Cookies A list of pairs of cookie name and value. + Return value An iolist with the generated cookie header value. +Changelog 2.9: Function introduced. Examples Generate a cookie header Cookie = cow_cookie:cookie([{&lt;&lt;"sessionid"&gt;&gt;, ID}]). See also cow_cookie(3), cow_cookie:parse_cookie(3), cow_cookie:parse_set_cookie(3), cow_cookie:setcookie(3)</description> + </item> + + <item> + <title>cow_cookie:cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3230,6 +3378,20 @@ Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A co <item> <title>cow_cookie:parse_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.parse_cookie/</guid> + <description>Name cow_cookie:parse_cookie - Parse a cookie header +Description parse_cookie(Cookie :: binary()) -&gt; [{binary(), binary()}] Parse a cookie header. +Arguments Cookie The cookie header value. + Return value A list of cookie name/value pairs is returned on success. +An exception is thrown in the event of a parse error. +Changelog 2.9: Fixes to the parser may lead to potential incompatibilities. A cookie name starting with $ is no longer ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3271,6 +3433,19 @@ An atom ignore is returned when the cookie has both an empty name and an empty v <item> <title>cow_cookie:parse_set_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.parse_set_cookie/</guid> + <description>Name cow_cookie:parse_set_cookie - Parse a set-cookie header +Description parse_set_cookie(SetCookie :: binary()) -&gt; {ok, Name, Value, Attrs} | ignore Name :: binary() Value :: binary() Attrs :: cow_cookie:cookie_attrs() Parse a set-cookie header. +Arguments SetCookie The set-cookie header value. + Return value An ok tuple with the cookie name, value and attributes is returned on success. +An atom ignore is returned when the cookie has both an empty name and an empty value, and must be ignored.</description> + </item> + + <item> + <title>cow_cookie:parse_set_cookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.parse_set_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3299,10 +3474,10 @@ Changelog 1.0: Function introduced. Examples Generate a set-cookie header SetC <item> <title>cow_cookie:setcookie(3)</title> - <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</link> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</guid> + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cow_cookie.setcookie/</guid> <description>Name cow_cookie:setcookie - Generate a set-cookie header Description setcookie(Name :: iodata(), Value :: iodata(), Opts :: cow_cookie:cookie_opts()) -&gt; iolist() Generate a set-cookie header. Arguments Name Cookie name. @@ -3314,10 +3489,10 @@ Changelog 1.0: Function introduced. Examples Generate a set-cookie header SetC <item> <title>cow_cookie:setcookie(3)</title> - <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/</link> + <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/</guid> + <guid>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</guid> <description>Name cow_cookie:setcookie - Generate a set-cookie header Description setcookie(Name :: iodata(), Value :: iodata(), Opts :: cow_cookie:cookie_opts()) -&gt; iolist() Generate a set-cookie header. Arguments Name Cookie name. @@ -3328,16 +3503,18 @@ Changelog 1.0: Function introduced. Examples Generate a set-cookie header SetC </item> <item> - <title>Cowboy Function Reference</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/</link> + <title>cow_cookie:setcookie(3)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/</guid> - <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP -Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. -Modules Functions: -cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> + <guid>https://ninenines.eu/docs/en/cowlib/2.9/manual/cow_cookie.setcookie/</guid> + <description>Name cow_cookie:setcookie - Generate a set-cookie header +Description setcookie(Name :: iodata(), Value :: iodata(), Opts :: cow_cookie:cookie_opts()) -&gt; iolist() Generate a set-cookie header. +Arguments Name Cookie name. + Value Cookie value. + Opts Options added to the set-cookie header as attributes. + Return value An iolist with the generated set-cookie header value. +Changelog 1.0: Function introduced. Examples Generate a set-cookie header SetCookie = cow_cookie:setcookie(&lt;&lt;"sessionid"&gt;&gt;, ID, #{ http_only =&gt; true, secure =&gt; true }).</description> </item> <item> @@ -3406,12 +3583,16 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> - <title>Cowboy User Guide</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/guide/</link> + <title>Cowboy Function Reference</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/guide/</guid> - <description>Rationale The modern Web Erlang and the Web Introduction Introduction Getting started Flow diagram Configuration Listeners Routing Constraints Handlers Handlers Loop handlers Static files Request and response Request details Reading the request body Sending a response Using cookies Multipart REST REST principles Handling REST requests REST flowcharts Designing a resource handler Websocket The Websocket protocol Websocket handlers Advanced Streams Middlewares Additional information Migrating from Cowboy 2.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/</guid> + <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP +Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. +Modules Functions: +cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> </item> <item> @@ -3460,14 +3641,12 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> - <title>cowboy(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy/</link> + <title>Cowboy User Guide</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy/</guid> - <description>Name cowboy - HTTP server -Description The module cowboy provides convenience functions for manipulating Ranch listeners. -Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:start_tls(3) - Listen for connections using TLS cowboy:stop_listener(3) - Stop the given listener cowboy:set_env(3) - Update a listener&apos;s environment value Types fields() fields() :: [Name | {Name, Constraints} | {Name, Constraints, Default}] Name :: atom() Constraints :: Constraint | [Constraint] Constraint :: cowboy_constraints:constraint() Default :: any() Fields description for match operations.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/guide/</guid> + <description>Rationale The modern Web Erlang and the Web Introduction Introduction Getting started Flow diagram Configuration Listeners Routing Constraints Handlers Handlers Loop handlers Static files Request and response Request details Reading the request body Sending a response Using cookies Multipart REST REST principles Handling REST requests REST flowcharts Designing a resource handler Websocket The Websocket protocol Websocket handlers Advanced Streams Middlewares Performance Additional information Migrating from Cowboy 2.</description> </item> <item> @@ -3526,16 +3705,14 @@ Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:s </item> <item> - <title>cowboy(7)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_app/</link> + <title>cowboy(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_app/</guid> - <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP -Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. -Modules Functions: -cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy/</guid> + <description>Name cowboy - HTTP server +Description The module cowboy provides convenience functions for manipulating Ranch listeners. +Exports cowboy:start_clear(3) - Listen for connections using plain TCP cowboy:start_tls(3) - Listen for connections using TLS cowboy:stop_listener(3) - Stop the given listener cowboy:set_env(3) - Update a listener&apos;s environment value Types fields() fields() :: [Name | {Name, Constraints} | {Name, Constraints, Default}] Name :: atom() Constraints :: Constraint | [Constraint] Constraint :: cowboy_constraints:constraint() Default :: any() Fields description for match operations.</description> </item> <item> @@ -3604,16 +3781,16 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> - <title>cowboy:set_env(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.set_env/</link> + <title>cowboy(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.set_env/</guid> - <description>Name cowboy:set_env - Update a listener&apos;s environment value -Description set_env(Name :: ranch:ref(), Key :: atom(), Value :: any()) -&gt; ok Set or update an environment value for a previously started listener. -This is most useful for updating the routes dynamically, without having to restart the listener. -The new value will only be available to new connections. Pre-existing connections will still use the old value. -Arguments Name The name of the listener to update.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_app/</guid> + <description>Name cowboy - Small, fast, modern HTTP server for Erlang/OTP +Description Cowboy is an HTTP server for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Cowboy aims to provide a complete HTTP stack. This includes the implementation of the HTTP RFCs but also any directly related standards, like Websocket or Server-Sent Events. +Modules Functions: +cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_router(3) - Router cowboy_constraints(3) - Constraints Protocols:</description> </item> <item> @@ -3682,15 +3859,16 @@ Arguments Name The name of the listener to update.</description> </item> <item> - <title>cowboy:start_clear(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.start_clear/</link> + <title>cowboy:set_env(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.set_env/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.start_clear/</guid> - <description>Name cowboy:start_clear - Listen for connections using plain TCP -Description start_clear(Name :: ranch:ref(), TransportOpts :: ranch_tcp:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a clear TCP channel. -Both HTTP/1.1 and HTTP/2 are supported on this listener. HTTP/2 has two methods of establishing a connection over a clear TCP channel. Both the upgrade and the prior knowledge methods are supported. -Arguments Name The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.set_env/</guid> + <description>Name cowboy:set_env - Update a listener&apos;s environment value +Description set_env(Name :: ranch:ref(), Key :: atom(), Value :: any()) -&gt; ok Set or update an environment value for a previously started listener. +This is most useful for updating the routes dynamically, without having to restart the listener. +The new value will only be available to new connections. Pre-existing connections will still use the old value. +Arguments Name The name of the listener to update.</description> </item> <item> @@ -3754,14 +3932,14 @@ Arguments Name The listener name is used to refer to this listener in future cal </item> <item> - <title>cowboy:start_tls(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.start_tls/</link> + <title>cowboy:start_clear(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.start_clear/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.start_tls/</guid> - <description>Name cowboy:start_tls - Listen for connections using TLS -Description start_tls(Name :: ranch:ref(), TransportOpts :: ranch_ssl:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a secure TLS channel. -Both HTTP/1.1 and HTTP/2 are supported on this listener. The ALPN TLS extension must be used to initiate an HTTP/2 connection. + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.start_clear/</guid> + <description>Name cowboy:start_clear - Listen for connections using plain TCP +Description start_clear(Name :: ranch:ref(), TransportOpts :: ranch_tcp:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a clear TCP channel. +Both HTTP/1.1 and HTTP/2 are supported on this listener. HTTP/2 has two methods of establishing a connection over a clear TCP channel. Both the upgrade and the prior knowledge methods are supported. Arguments Name The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</description> </item> @@ -3826,18 +4004,15 @@ Arguments Name The listener name is used to refer to this listener in future cal </item> <item> - <title>cowboy:stop_listener(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.stop_listener/</link> + <title>cowboy:start_tls(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.start_tls/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy.stop_listener/</guid> - <description>Name cowboy:stop_listener - Stop the given listener -Description stop_listener(Name :: ranch:ref()) -&gt; ok | {error, not_found}. Stop a previously started listener. -Alias of ranch:stop_listener(3). -Arguments Name The name of the listener to be stopped. -The name of the listener is the first argument given to the cowboy:start_clear(3), cowboy:start_tls(3) or ranch:start_listener(3) function. - Return value The atom ok is returned on success. -The {error, not_found} tuple is returned when the listener does not exist.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.start_tls/</guid> + <description>Name cowboy:start_tls - Listen for connections using TLS +Description start_tls(Name :: ranch:ref(), TransportOpts :: ranch_ssl:opts(), ProtocolOpts :: opts()) -&gt; {ok, ListenerPid :: pid()} | {error, any()} Start listening for connections over a secure TLS channel. +Both HTTP/1.1 and HTTP/2 are supported on this listener. The ALPN TLS extension must be used to initiate an HTTP/2 connection. +Arguments Name The listener name is used to refer to this listener in future calls, for example when stopping it or when updating the routes defined.</description> </item> <item> @@ -3916,6 +4091,21 @@ The {error, not_found} tuple is returned when the listener does not exist.</desc </item> <item> + <title>cowboy:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy.stop_listener/</guid> + <description>Name cowboy:stop_listener - Stop the given listener +Description stop_listener(Name :: ranch:ref()) -&gt; ok | {error, not_found}. Stop a previously started listener. +Alias of ranch:stop_listener(3). +Arguments Name The name of the listener to be stopped. +The name of the listener is the first argument given to the cowboy:start_clear(3), cowboy:start_tls(3) or ranch:start_listener(3) function. + Return value The atom ok is returned on success. +The {error, not_found} tuple is returned when the listener does not exist.</description> + </item> + + <item> <title>cowboy_compress_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_compress_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -3949,16 +4139,14 @@ Normal responses will only be compressed when their size is lower than the confi </item> <item> - <title>cowboy_constraints(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints/</link> + <title>cowboy_compress_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_compress_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints/</guid> - <description>Name cowboy_constraints - Constraints -Description The module cowboy_constraints defines the built-in constraints in Cowboy and provides an interface for manipulating these constraints. -Constraints are functions that define what type of input is allowed. They are used throughout Cowboy, from the router to query strings to cookies. -Exports Built-in constraints: -cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - Non-empty constraint Types constraint() constraint() :: int | nonempty | fun() A constraint function.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_compress_h/</guid> + <description>Name cowboy_compress_h - Compress stream handler +Description The module cowboy_compress_h compresses response bodies automatically when the client supports it. It will not try to compress responses that already have a content encoding. +Normal responses will only be compressed when their size is lower than the configured threshold. Streamed responses are always compressed, including when the sendfile command is used. Because the file must be read in memory to be compressed, this module is not suitable for automatically compressing large files.</description> </item> <item> @@ -4027,16 +4215,16 @@ cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - </item> <item> - <title>cowboy_constraints:int(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints.int/</link> + <title>cowboy_constraints(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints.int/</guid> - <description>Name cowboy_constraints:int - Integer constraint -Description Constraint functions implement a number of different operations. -int(forward, Bin) -&gt; {ok, Int} | {error, not_an_integer} Bin :: binary() Int :: integer() Validate and convert the text representation of an integer. -int(reverse, Int) -&gt; {ok, Bin} | {error, not_an_integer} Convert an integer back to its text representation. -int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | Int} HumanReadable :: iolist() Generate a human-readable error message.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints/</guid> + <description>Name cowboy_constraints - Constraints +Description The module cowboy_constraints defines the built-in constraints in Cowboy and provides an interface for manipulating these constraints. +Constraints are functions that define what type of input is allowed. They are used throughout Cowboy, from the router to query strings to cookies. +Exports Built-in constraints: +cowboy_constraints:int(3) - Integer constraint cowboy_constraints:nonempty(3) - Non-empty constraint Types constraint() constraint() :: int | nonempty | fun() A constraint function.</description> </item> <item> @@ -4105,17 +4293,16 @@ int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | </item> <item> - <title>cowboy_constraints:nonempty(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/</link> + <title>cowboy_constraints:int(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints.int/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_constraints.nonempty/</guid> - <description>Name cowboy_constraints:nonempty - Non-empty constraint + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints.int/</guid> + <description>Name cowboy_constraints:int - Integer constraint Description Constraint functions implement a number of different operations. -nonempty(forward | reverse, &lt;&lt;&gt;&gt;) -&gt; {error, empty} Reject empty values. -nonempty(forward | reverse, Bin) -&gt; {ok, Bin} Bin :: binary() Accept any other binary values. -nonempty(format_error, Error) -&gt; HumanReadable Error :: {empty, Bin} HumanReadable :: iolist() Generate a human-readable error message. -Arguments Arguments vary depending on the operation. Constraint functions always take the operation type as first argument, and the value as second argument.</description> +int(forward, Bin) -&gt; {ok, Int} | {error, not_an_integer} Bin :: binary() Int :: integer() Validate and convert the text representation of an integer. +int(reverse, Int) -&gt; {ok, Bin} | {error, not_an_integer} Convert an integer back to its text representation. +int(format_error, Error) -&gt; HumanReadable Error :: {not_an_integer, Bin | Int} HumanReadable :: iolist() Generate a human-readable error message.</description> </item> <item> @@ -4189,15 +4376,17 @@ Arguments Arguments vary depending on the operation. Constraint functions always </item> <item> - <title>cowboy_handler(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_handler/</link> + <title>cowboy_constraints:nonempty(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_handler/</guid> - <description>Name cowboy_handler - Plain HTTP handlers -Description The cowboy_handler middleware executes the handler selected by the router or any other preceding middleware. -This middleware takes the handler module and initial state from the handler and handler_opts environment values, respectively. On completion, it adds a result value to the middleware environment, containing the return value of the terminate/3 callback (if defined) and ok otherwise. -This module also defines a callback interface for handling HTTP requests.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_constraints.nonempty/</guid> + <description>Name cowboy_constraints:nonempty - Non-empty constraint +Description Constraint functions implement a number of different operations. +nonempty(forward | reverse, &lt;&lt;&gt;&gt;) -&gt; {error, empty} Reject empty values. +nonempty(forward | reverse, Bin) -&gt; {ok, Bin} Bin :: binary() Accept any other binary values. +nonempty(format_error, Error) -&gt; HumanReadable Error :: {empty, Bin} HumanReadable :: iolist() Generate a human-readable error message. +Arguments Arguments vary depending on the operation. Constraint functions always take the operation type as first argument, and the value as second argument.</description> </item> <item> @@ -4261,17 +4450,15 @@ This module also defines a callback interface for handling HTTP requests.</descr </item> <item> - <title>cowboy_handler:terminate(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/</link> + <title>cowboy_handler(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_handler/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_handler.terminate/</guid> - <description>Name cowboy_handler:terminate - Terminate the handler -Description terminate(Reason, PartialReq, State, Handler) -&gt; ok Reason :: any() PartialReq :: map() State :: any() Handler :: module() Call the optional terminate callback if it is defined. -Make sure to use this function at the end of the execution of modules that implement custom handler behaviors. -Arguments Reason Reason for termination. - PartialReq The Req object. -It is possible to remove fields from the Req object to save memory when the handler has no concept of requests/responses.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_handler/</guid> + <description>Name cowboy_handler - Plain HTTP handlers +Description The cowboy_handler middleware executes the handler selected by the router or any other preceding middleware. +This middleware takes the handler module and initial state from the handler and handler_opts environment values, respectively. On completion, it adds a result value to the middleware environment, containing the return value of the terminate/3 callback (if defined) and ok otherwise. +This module also defines a callback interface for handling HTTP requests.</description> </item> <item> @@ -4345,14 +4532,17 @@ It is possible to remove fields from the Req object to save memory when the hand </item> <item> - <title>cowboy_http(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_http/</link> + <title>cowboy_handler:terminate(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_http/</guid> - <description>Name cowboy_http - HTTP/1.1 -Description The module cowboy_http implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol. -Options opts() :: #{ connection_type =&gt; worker | supervisor, env =&gt; cowboy_middleware:env(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), max_empty_lines =&gt; non_neg_integer(), max_header_name_length =&gt; non_neg_integer(), max_header_value_length =&gt; non_neg_integer(), max_headers =&gt; non_neg_integer(), max_keepalive =&gt; non_neg_integer(), max_method_length =&gt; non_neg_integer(), max_request_line_length =&gt; non_neg_integer(), max_skip_body_length =&gt; non_neg_integer(), middlewares =&gt; [module()], request_timeout =&gt; timeout(), shutdown_timeout =&gt; timeout(), stream_handlers =&gt; [module()] } Configuration for the HTTP/1.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_handler.terminate/</guid> + <description>Name cowboy_handler:terminate - Terminate the handler +Description terminate(Reason, PartialReq, State, Handler) -&gt; ok Reason :: any() PartialReq :: map() State :: any() Handler :: module() Call the optional terminate callback if it is defined. +Make sure to use this function at the end of the execution of modules that implement custom handler behaviors. +Arguments Reason Reason for termination. + PartialReq The Req object. +It is possible to remove fields from the Req object to save memory when the handler has no concept of requests/responses.</description> </item> <item> @@ -4411,16 +4601,14 @@ Options opts() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean </item> <item> - <title>cowboy_http2(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_http2/</link> + <title>cowboy_http(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_http/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_http2/</guid> - <description>Name cowboy_http2 - HTTP/2 -Description The module cowboy_http2 implements HTTP/2 as a Ranch protocol. -Options opts() :: #{ connection_type =&gt; worker | supervisor, env =&gt; cowboy_middleware:env(), inactivity_timeout =&gt; timeout(), middlewares =&gt; [module()], preface_timeout =&gt; timeout(), shutdown_timeout =&gt; timeout(), stream_handlers =&gt; [module()] } Configuration for the HTTP/2 protocol. -This configuration is passed to Cowboy when starting listeners using cowboy:start_clear/3 or cowboy:start_tls/3 functions. -It can be updated without restarting listeners using the Ranch functions ranch:get_protocol_options/1 and ranch:set_protocol_options/2.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_http/</guid> + <description>Name cowboy_http - HTTP/1.1 +Description The module cowboy_http implements HTTP/1.1 and HTTP/1.0 as a Ranch protocol. +Options opts() :: #{ active_n =&gt; pos_integer(), chunked =&gt; boolean(), connection_type =&gt; worker | supervisor, http10_keepalive =&gt; boolean(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_stream_flow_size =&gt; non_neg_integer(), linger_timeout =&gt; timeout(), logger =&gt; module(), max_empty_lines =&gt; non_neg_integer(), max_header_name_length =&gt; non_neg_integer(), max_header_value_length =&gt; non_neg_integer(), max_headers =&gt; non_neg_integer(), max_keepalive =&gt; non_neg_integer(), max_method_length =&gt; non_neg_integer(), max_request_line_length =&gt; non_neg_integer(), max_skip_body_length =&gt; non_neg_integer(), proxy_header =&gt; boolean(), request_timeout =&gt; timeout(), sendfile =&gt; boolean(), stream_handlers =&gt; [module()] } Configuration for the HTTP/1.</description> </item> <item> @@ -4479,16 +4667,14 @@ Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; </item> <item> - <title>cowboy_loop(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_loop/</link> + <title>cowboy_http2(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_http2/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_loop/</guid> - <description>Name cowboy_loop - Loop handlers -Description The module cowboy_loop defines a callback interface for long running HTTP connections. -You should switch to this behavior for long polling, server-sent events and similar long-running requests. -There are generally two usage patterns: -Loop until receiving a specific message, then send a response and stop execution (for example long polling); Or initiate a response in init/2 and stream the body in info/3 as necessary (for example server-sent events).</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_http2/</guid> + <description>Name cowboy_http2 - HTTP/2 +Description The module cowboy_http2 implements HTTP/2 as a Ranch protocol. +Options opts() :: #{ active_n =&gt; pos_integer(), connection_type =&gt; worker | supervisor, connection_window_margin_size =&gt; 0..16#7fffffff, connection_window_update_threshold =&gt; 0..16#7fffffff, enable_connect_protocol =&gt; boolean(), goaway_initial_timeout =&gt; timeout(), goaway_complete_timeout =&gt; timeout(), idle_timeout =&gt; timeout(), inactivity_timeout =&gt; timeout(), initial_connection_window_size =&gt; 65535..16#7fffffff, initial_stream_window_size =&gt; 0..16#7fffffff, linger_timeout =&gt; timeout(), logger =&gt; module(), max_concurrent_streams =&gt; non_neg_integer() | infinity, max_connection_buffer_size =&gt; non_neg_integer(), max_connection_window_size =&gt; 0..16#7fffffff, max_decode_table_size =&gt; non_neg_integer(), max_encode_table_size =&gt; non_neg_integer(), max_frame_size_received =&gt; 16384.</description> </item> <item> @@ -4557,6 +4743,19 @@ Loop until receiving a specific message, then send a response and stop execution </item> <item> + <title>cowboy_loop(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_loop/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_loop/</guid> + <description>Name cowboy_loop - Loop handlers +Description The module cowboy_loop defines a callback interface for long running HTTP connections. +You should switch to this behavior for long polling, server-sent events and similar long-running requests. +There are generally two usage patterns: +Loop until receiving a specific message, then send a response and stop execution (for example long polling); Or initiate a response in init/2 and stream the body in info/3 as necessary (for example server-sent events).</description> + </item> + + <item> <title>cowboy_metrics_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_metrics_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4579,16 +4778,14 @@ Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranc </item> <item> - <title>cowboy_middleware(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_middleware/</link> + <title>cowboy_metrics_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_metrics_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_middleware/</guid> - <description>Name cowboy_middleware - Middlewares -Description The module cowboy_middleware defines a callback interface for Cowboy middlewares. -Middlewares process the request sequentially in the order they are configured. -Callbacks Middlewares implement the following interface: -execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()]} | {stop, Req} Req :: cowboy_req:req() Env :: cowboy_middleware:env() The execute/2 is the only callback that needs to be implemented. It must execute the middleware and return with instructions for Cowboy.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_metrics_h/</guid> + <description>Name cowboy_metrics_h - Metrics stream handler +Description The module cowboy_metrics_h gathers metrics and other information about a stream. It then calls the configured callback with this data. +Types metrics() metrics() :: #{ %% The identifier for this listener. ref := ranch:ref(), %% The pid for this connection. pid := pid(), %% The streamid also indicates the total number of requests on %% this connection (StreamID div 2 + 1). streamid := cowboy_stream:streamid(), %% The terminate reason is always useful.</description> </item> <item> @@ -4657,15 +4854,16 @@ execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()] </item> <item> - <title>cowboy_req(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req/</link> + <title>cowboy_middleware(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_middleware/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req/</guid> - <description>Name cowboy_req - HTTP request and response -Description The module cowboy_req provides functions to access, manipulate and respond to requests. -There are four types of functions in this module. They can be differentiated by their name and their return type: -Type Name pattern Return type access no verb, parse_*, match_* Value question has_* boolean() modification set_* Req action any other verb ok | {Result, Value, Req} Any Req returned must be used in place of the one passed as argument.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_middleware/</guid> + <description>Name cowboy_middleware - Middlewares +Description The module cowboy_middleware defines a callback interface for Cowboy middlewares. +Middlewares process the request sequentially in the order they are configured. +Callbacks Middlewares implement the following interface: +execute(Req, Env) -&gt; {ok, Req, Env} | {suspend, module(), atom(), [any()]} | {stop, Req} Req :: cowboy_req:req() Env :: cowboy_middleware:env() The execute/2 is the only callback that needs to be implemented. It must execute the middleware and return with instructions for Cowboy.</description> </item> <item> @@ -4729,17 +4927,15 @@ Type Name pattern Return type access no verb, parse_*, match_* Value question h </item> <item> - <title>cowboy_req:binding(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.binding/</link> + <title>cowboy_req(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.binding/</guid> - <description>Name cowboy_req:binding - Access a value bound from the route -Description binding(Name, Req) -&gt; binding(Name, Req, undefined) binding(Name, Req, Default) -&gt; any() | Default Name :: atom() Req :: cowboy_req:req() Default :: any() Return the value for the given binding. -Arguments Name Desired binding name as an atom. - Req The Req object. - Default Default value returned when the binding is missing. - Return value By default the value is a case sensitive binary string, however constraints may change the type of this value (for example automatically converting numbers to integer).</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req/</guid> + <description>Name cowboy_req - HTTP request and response +Description The module cowboy_req provides functions to access, manipulate and respond to requests. +There are four types of functions in this module. They can be differentiated by their name and their return type: +Type Name pattern Return type access no verb, parse_*, match_* Value question has_* boolean() modification set_* Req action any other verb ok | {Result, Value, Req} Any Req returned must be used in place of the one passed as argument.</description> </item> <item> @@ -4813,16 +5009,17 @@ Arguments Name Desired binding name as an atom. </item> <item> - <title>cowboy_req:bindings(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.bindings/</link> + <title>cowboy_req:binding(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.binding/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.bindings/</guid> - <description>Name cowboy_req:bindings - Access all values bound from the route -Description bindings(Req :: cowboy_req:req()) -&gt; cowboy_router:bindings() Return a map containing all bindings. -Arguments Req The Req object. - Return value By default values are case sensitive binary strings, however constraints may change the type of this value (for example automatically converting numbers to integer). -Changelog 2.0: Only the values are returned, they are no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.binding/</guid> + <description>Name cowboy_req:binding - Access a value bound from the route +Description binding(Name, Req) -&gt; binding(Name, Req, undefined) binding(Name, Req, Default) -&gt; any() | Default Name :: atom() Req :: cowboy_req:req() Default :: any() Return the value for the given binding. +Arguments Name Desired binding name as an atom. + Req The Req object. + Default Default value returned when the binding is missing. + Return value By default the value is a case sensitive binary string, however constraints may change the type of this value (for example automatically converting numbers to integer).</description> </item> <item> @@ -4891,16 +5088,16 @@ Changelog 2.0: Only the values are returned, they are no longer wrapped in a tup </item> <item> - <title>cowboy_req:body_length(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.body_length/</link> + <title>cowboy_req:bindings(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.bindings/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.body_length/</guid> - <description>Name cowboy_req:body_length - Body length -Description body_length(Req :: cowboy_req:req()) -&gt; undefined | non_neg_integer() Return the length of the request body. -The length is not always known before reading the body. In those cases Cowboy will return undefined. The body length is available after the body has been fully read. + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.bindings/</guid> + <description>Name cowboy_req:bindings - Access all values bound from the route +Description bindings(Req :: cowboy_req:req()) -&gt; cowboy_router:bindings() Return a map containing all bindings. Arguments Req The Req object. - Return value The length of the request body, or undefined if it is not known.</description> + Return value By default values are case sensitive binary strings, however constraints may change the type of this value (for example automatically converting numbers to integer). +Changelog 2.0: Only the values are returned, they are no longer wrapped in a tuple.</description> </item> <item> @@ -4969,6 +5166,19 @@ Arguments Req The Req object. </item> <item> + <title>cowboy_req:body_length(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.body_length/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.body_length/</guid> + <description>Name cowboy_req:body_length - Body length +Description body_length(Req :: cowboy_req:req()) -&gt; undefined | non_neg_integer() Return the length of the request body. +The length is not always known before reading the body. In those cases Cowboy will return undefined. The body length is available after the body has been fully read. +Arguments Req The Req object. + Return value The length of the request body, or undefined if it is not known.</description> + </item> + + <item> <title>cowboy_req:cast(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.cast/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4999,15 +5209,18 @@ Changelog 2.7: Function introduced. Examples Increase the HTTP/1.</description </item> <item> - <title>cowboy_req:cert(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.cert/</link> + <title>cowboy_req:cast(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.cast/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.cert/</guid> - <description>Name cowboy_req:cert - Client TLS certificate -Description cert(Req :: cowboy_req:req()) -&gt; binary() | undefined Return the peer&apos;s TLS certificate. -Using the default configuration this function will always return undefined. You need to explicitly configure Cowboy to request the client certificate. To do this you need to set the verify transport option to verify_peer: -{ok, _} = cowboy:start_tls(example, [ {port, 8443}, {cert, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.cast/</guid> + <description>Name cowboy_req:cast - Cast a stream handler event +Description cast(Event :: any(), Req :: cowboy_req:req()) -&gt; ok Cast a stream handler event. +The event will be passed to stream handlers through the info/3 callback. +Arguments Event The event to be sent to stream handlers. + Req The Req object. + Return value The atom ok is always returned. It can be safely ignored. +Changelog 2.7: Function introduced. Examples Increase the HTTP/1.</description> </item> <item> @@ -5071,17 +5284,15 @@ Using the default configuration this function will always return undefined. You </item> <item> - <title>cowboy_req:delete_resp_header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/</link> + <title>cowboy_req:cert(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.cert/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.delete_resp_header/</guid> - <description>Name cowboy_req:delete_resp_header - Delete a response header -Description delete_resp_header(Name, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Delete the given response header. -The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Arguments Name Header name as a lowercase binary string. - Req The Req object. - Return value A new Req object is returned.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.cert/</guid> + <description>Name cowboy_req:cert - Client TLS certificate +Description cert(Req :: cowboy_req:req()) -&gt; binary() | undefined Return the peer&apos;s TLS certificate. +Using the default configuration this function will always return undefined. You need to explicitly configure Cowboy to request the client certificate. To do this you need to set the verify transport option to verify_peer: +{ok, _} = cowboy:start_tls(example, [ {port, 8443}, {certfile, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> </item> <item> @@ -5155,6 +5366,20 @@ Arguments Name Header name as a lowercase binary string. </item> <item> + <title>cowboy_req:delete_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.delete_resp_header/</guid> + <description>Name cowboy_req:delete_resp_header - Delete a response header +Description delete_resp_header(Name, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Delete the given response header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Arguments Name Header name as a lowercase binary string. + Req The Req object. + Return value A new Req object is returned.</description> + </item> + + <item> <title>cowboy_req:filter_cookies(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_req.filter_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -5179,16 +5404,15 @@ Malformed cookies are unfortunately fairly common due to the string-based interf </item> <item> - <title>cowboy_req:has_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_body/</link> + <title>cowboy_req:filter_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_body/</guid> - <description>Name cowboy_req:has_body - Is there a request body? -Description has_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether the request has a body. -Arguments Req The Req object. - Return value A boolean indicating whether the request has a body. -Changelog 1.0: Function introduced. Examples Ensure the request has a body true = cowboy_req:has_body(Req). See also cowboy_req(3), cowboy_req:body_length(3), cowboy_req:read_body(3), cowboy_req:read_urlencoded_body(3), cowboy_req:read_part(3), cowboy_req:read_part_body(3)</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.filter_cookies/</guid> + <description>Name cowboy_req:filter_cookies - Filter cookie headers +Description filter_cookies(Names, Req) -&gt; Req Names :: [atom() | binary()] Filter cookie headers. +This function is meant to be used before attempting to parse or match cookies in order to remove cookies that are not relevant and are potentially malformed. Because Cowboy by default crashes on malformed cookies, this function allows processing requests that would otherwise result in a 400 error. +Malformed cookies are unfortunately fairly common due to the string-based interface provided by browsers and this function provides a middle ground between Cowboy&apos;s strict behavior and chaotic real world use cases.</description> </item> <item> @@ -5257,17 +5481,16 @@ Changelog 1.0: Function introduced. Examples Ensure the request has a body tru </item> <item> - <title>cowboy_req:has_resp_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/</link> + <title>cowboy_req:has_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_body/</guid> - <description>Name cowboy_req:has_resp_body - Is there a response body? -Description has_resp_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether a response body has been set. + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_body/</guid> + <description>Name cowboy_req:has_body - Is there a request body? +Description has_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether the request has a body. Arguments Req The Req object. - Return value A boolean indicating whether a response body has been set. -This function will return false when an empty response body has been set. -Changelog 1.0: Function introduced. Examples Check whether a body has been set false = cowboy_req:has_resp_body(Req0), Req1 = cowboy_req:set_resp_body(&lt;&lt;"</description> + Return value A boolean indicating whether the request has a body. +Changelog 1.0: Function introduced. Examples Ensure the request has a body true = cowboy_req:has_body(Req). See also cowboy_req(3), cowboy_req:body_length(3), cowboy_req:read_body(3), cowboy_req:read_urlencoded_body(3), cowboy_req:read_part(3), cowboy_req:read_part_body(3)</description> </item> <item> @@ -5341,15 +5564,17 @@ Changelog 1.0: Function introduced. Examples Check whether a body has been set </item> <item> - <title>cowboy_req:has_resp_header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/</link> + <title>cowboy_req:has_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.has_resp_header/</guid> - <description>Name cowboy_req:has_resp_header - Is the given response header set? -Description has_resp_header(Name, Req :: cowboy_req:req()) -&gt; boolean() Name :: binary() %% lowercase; case insensitive Return whether the given response header has been set. -The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Arguments Name Header name as a lowercase binary string.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_body/</guid> + <description>Name cowboy_req:has_resp_body - Is there a response body? +Description has_resp_body(Req :: cowboy_req:req()) -&gt; boolean() Return whether a response body has been set. +Arguments Req The Req object. + Return value A boolean indicating whether a response body has been set. +This function will return false when an empty response body has been set. +Changelog 1.0: Function introduced. Examples Check whether a body has been set false = cowboy_req:has_resp_body(Req0), Req1 = cowboy_req:set_resp_body(&lt;&lt;"</description> </item> <item> @@ -5413,15 +5638,15 @@ Arguments Name Header name as a lowercase binary string.</description> </item> <item> - <title>cowboy_req:header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.header/</link> + <title>cowboy_req:has_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.header/</guid> - <description>Name cowboy_req:header - HTTP header -Description header(Name, Req) -&gt; header(Name, Req, undefined) header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given HTTP header. + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.has_resp_header/</guid> + <description>Name cowboy_req:has_resp_header - Is the given response header set? +Description has_resp_header(Name, Req :: cowboy_req:req()) -&gt; boolean() Name :: binary() %% lowercase; case insensitive Return whether the given response header has been set. The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Headers can also be obtained using pattern matching:</description> +Arguments Name Header name as a lowercase binary string.</description> </item> <item> @@ -5485,17 +5710,15 @@ Headers can also be obtained using pattern matching:</description> </item> <item> - <title>cowboy_req:headers(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.headers/</link> + <title>cowboy_req:header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.headers/</guid> - <description>Name cowboy_req:headers - HTTP headers -Description headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all request headers. -Request headers can also be obtained using pattern matching: -#{headers := Headers} = Req. Arguments Req The Req object. - Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. -Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.header/</guid> + <description>Name cowboy_req:header - HTTP header +Description header(Name, Req) -&gt; header(Name, Req, undefined) header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given HTTP header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Headers can also be obtained using pattern matching:</description> </item> <item> @@ -5569,17 +5792,17 @@ Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tu </item> <item> - <title>cowboy_req:host(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.host/</link> + <title>cowboy_req:headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.host/</guid> - <description>Name cowboy_req:host - URI host name -Description host(Req :: cowboy_req:req()) -&gt; Host :: binary() Return the host name of the effective request URI. -The host name can also be obtained using pattern matching: -#{host := Host} = Req. Arguments Req The Req object. - Return value The host name is returned as a lowercase binary string. It is case insensitive. -Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.headers/</guid> + <description>Name cowboy_req:headers - HTTP headers +Description headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all request headers. +Request headers can also be obtained using pattern matching: +#{headers := Headers} = Req. Arguments Req The Req object. + Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. +Changelog 2.0: Only the headers are returned, they are no longer wrapped in a tuple.</description> </item> <item> @@ -5653,17 +5876,17 @@ Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tupl </item> <item> - <title>cowboy_req:host_info(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.host_info/</link> + <title>cowboy_req:host(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.host/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.host_info/</guid> - <description>Name cowboy_req:host_info - Access the route&apos;s heading host segments -Description host_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the heading host segments. -This is the part of the host name that was matched using the ... notation. -Arguments Req The Req object. - Return value The tokens are returned as a list of case insensitive binary strings. -Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.host/</guid> + <description>Name cowboy_req:host - URI host name +Description host(Req :: cowboy_req:req()) -&gt; Host :: binary() Return the host name of the effective request URI. +The host name can also be obtained using pattern matching: +#{host := Host} = Req. Arguments Req The Req object. + Return value The host name is returned as a lowercase binary string. It is case insensitive. +Changelog 2.0: Only the host name is returned, it is no longer wrapped in a tuple.</description> </item> <item> @@ -5737,15 +5960,17 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup </item> <item> - <title>cowboy_req:inform(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.inform/</link> + <title>cowboy_req:host_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.host_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.inform/</guid> - <description>Name cowboy_req:inform - Send an informational response -Description inform(Status, Req :: cowboy_req:req()) -&gt; inform(StatusCode, #{}, Req) inform(Status, Headers, Req :: cowboy_req:req()) -&gt; ok Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send an informational response. -Informational responses use a status code between 100 and 199. They cannot include a body. This function will not use any of the previously set headers. All headers to be sent must be given directly. -Any number of informational responses can be sent as long as they are sent before the proper response.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.host_info/</guid> + <description>Name cowboy_req:host_info - Access the route&apos;s heading host segments +Description host_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the heading host segments. +This is the part of the host name that was matched using the ... notation. +Arguments Req The Req object. + Return value The tokens are returned as a list of case insensitive binary strings. +Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> </item> <item> @@ -5809,14 +6034,15 @@ Any number of informational responses can be sent as long as they are sent befor </item> <item> - <title>cowboy_req:match_cookies(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/</link> + <title>cowboy_req:inform(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.inform/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.match_cookies/</guid> - <description>Name cowboy_req:match_cookies - Match cookies against constraints -Description match_cookies(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the cookies and match specific values against constraints. -Cowboy will only return the cookie values specified in the fields list, and ignore all others. Fields can be either the name of the cookie requested; the name along with a list of constraints; or the name, a list of constraints and a default value in case the cookie is missing.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.inform/</guid> + <description>Name cowboy_req:inform - Send an informational response +Description inform(Status, Req :: cowboy_req:req()) -&gt; inform(StatusCode, #{}, Req) inform(Status, Headers, Req :: cowboy_req:req()) -&gt; ok Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send an informational response. +Informational responses use a status code between 100 and 199. They cannot include a body. This function will not use any of the previously set headers. All headers to be sent must be given directly. +Any number of informational responses can be sent as long as they are sent before the proper response.</description> </item> <item> @@ -5875,14 +6101,14 @@ Cowboy will only return the cookie values specified in the fields list, and igno </item> <item> - <title>cowboy_req:match_qs(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/</link> + <title>cowboy_req:match_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.match_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.match_qs/</guid> - <description>Name cowboy_req:match_qs - Match the query string against constraints -Description match_qs(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the query string and match specific values against constraints. -Cowboy will only return the query string values specified in the fields list, and ignore all others. Fields can be either the key requested; the key along with a list of constraints; or the key, a list of constraints and a default value in case the key is missing.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.match_cookies/</guid> + <description>Name cowboy_req:match_cookies - Match cookies against constraints +Description match_cookies(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the cookies and match specific values against constraints. +Cowboy will only return the cookie values specified in the fields list, and ignore all others. Fields can be either the name of the cookie requested; the name along with a list of constraints; or the name, a list of constraints and a default value in case the cookie is missing.</description> </item> <item> @@ -5941,17 +6167,14 @@ Cowboy will only return the query string values specified in the fields list, an </item> <item> - <title>cowboy_req:method(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.method/</link> + <title>cowboy_req:match_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.method/</guid> - <description>Name cowboy_req:method - HTTP method -Description method(Req :: cowboy_req:req()) -&gt; Method :: binary() Return the request&apos;s HTTP method. -The method can also be obtained using pattern matching: -#{method := Method} = Req. Arguments Req The Req object. - Return value The request&apos;s HTTP method is returned as a binary string. While methods are case sensitive, standard methods are always uppercase. -Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.match_qs/</guid> + <description>Name cowboy_req:match_qs - Match the query string against constraints +Description match_qs(Fields :: cowboy:fields(), Req :: cowboy_req:req()) -&gt; #{atom() =&gt; any()} Parse the query string and match specific values against constraints. +Cowboy will only return the query string values specified in the fields list, and ignore all others. Fields can be either the key requested; the key along with a list of constraints; or the key, a list of constraints and a default value in case the key is missing.</description> </item> <item> @@ -6025,18 +6248,17 @@ Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.< </item> <item> - <title>cowboy_req:parse_cookies(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/</link> + <title>cowboy_req:method(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.method/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_cookies/</guid> - <description>Name cowboy_req:parse_cookies - Parse cookie headers -Description parse_cookies(Req) -&gt; [{Name, Value}] Name :: binary() %% case sensitive Value :: binary() %% case sensitive Parse cookie headers. -Alias for cowboy_req:parse_header(&lt;&lt;&quot;cookie&quot;&gt;&gt;, Req). -When the cookie header is missing, [] is returned. -While an empty cookie header is not valid, some clients do send it. Cowboy will in this case also return []. -Arguments Req The Req object. - Return value The cookies are returned as a list of key/values.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.method/</guid> + <description>Name cowboy_req:method - HTTP method +Description method(Req :: cowboy_req:req()) -&gt; Method :: binary() Return the request&apos;s HTTP method. +The method can also be obtained using pattern matching: +#{method := Method} = Req. Arguments Req The Req object. + Return value The request&apos;s HTTP method is returned as a binary string. While methods are case sensitive, standard methods are always uppercase. +Changelog 2.0: Only the method is returned, it is no longer wrapped in a tuple.</description> </item> <item> @@ -6111,15 +6333,16 @@ This function will crash on invalid cookie data. Because invalid cookies are fai </item> <item> - <title>cowboy_req:parse_header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/</link> + <title>cowboy_req:parse_cookies(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_header/</guid> - <description>Name cowboy_req:parse_header - Parse the given HTTP header -Description parse_header(Name, Req) -&gt; ParsedValue | Default parse_header(Name, Req, Default) -&gt; ParsedValue | Default Name :: binary() Req :: cowboy_req:req() ParsedValue :: any() Default :: any() Parse the given HTTP header. -The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -The type of the parsed value varies depending on the header.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_cookies/</guid> + <description>Name cowboy_req:parse_cookies - Parse cookie headers +Description parse_cookies(Req) -&gt; [{Name, Value}] Name :: binary() %% case sensitive Value :: binary() %% case sensitive Parse cookie headers. +Alias for cowboy_req:parse_header(&lt;&lt;&quot;cookie&quot;&gt;&gt;, Req). +When the cookie header is missing or empty, [] is returned. +This function will crash on invalid cookie data. Because invalid cookies are fairly common when dealing with browsers (because of the string interface that the Javascript API provides), it is recommended to filter the cookie header value before attempting to parse it.</description> </item> <item> @@ -6183,15 +6406,15 @@ The type of the parsed value varies depending on the header.</description> </item> <item> - <title>cowboy_req:parse_qs(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/</link> + <title>cowboy_req:parse_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.parse_qs/</guid> - <description>Name cowboy_req:parse_qs - Parse the query string -Description parse_qs(Req :: cowboy_req:req()) -&gt; [{Key :: binary(), Value :: binary() | true}] Parse the query string as a list of key/value pairs. -Arguments Req The Req object. - Return value The parsed query string is returned as a list of key/value pairs. The key is a binary string. The value is either a binary string, or the atom true. Both key and value are case sensitive.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_header/</guid> + <description>Name cowboy_req:parse_header - Parse the given HTTP header +Description parse_header(Name, Req) -&gt; ParsedValue | Default parse_header(Name, Req, Default) -&gt; ParsedValue | Default Name :: binary() Req :: cowboy_req:req() ParsedValue :: any() Default :: any() Parse the given HTTP header. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +The type of the parsed value varies depending on the header.</description> </item> <item> @@ -6255,17 +6478,15 @@ Arguments Req The Req object. </item> <item> - <title>cowboy_req:path(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.path/</link> + <title>cowboy_req:parse_qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.path/</guid> - <description>Name cowboy_req:path - URI path -Description path(Req :: cowboy_req:req()) -&gt; Path :: binary() Return the path of the effective request URI. -The path can also be obtained using pattern matching: -#{path := Path} = Req. Arguments Req The Req object. - Return value The path is returned as a binary string. It is case sensitive. -Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.parse_qs/</guid> + <description>Name cowboy_req:parse_qs - Parse the query string +Description parse_qs(Req :: cowboy_req:req()) -&gt; [{Key :: binary(), Value :: binary() | true}] Parse the query string as a list of key/value pairs. +Arguments Req The Req object. + Return value The parsed query string is returned as a list of key/value pairs. The key is a binary string. The value is either a binary string, or the atom true. Both key and value are case sensitive.</description> </item> <item> @@ -6339,17 +6560,17 @@ Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</d </item> <item> - <title>cowboy_req:path_info(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.path_info/</link> + <title>cowboy_req:path(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.path/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.path_info/</guid> - <description>Name cowboy_req:path_info - Access the route&apos;s trailing path segments -Description path_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the trailing path segments. -This is the part of the host name that was matched using the ... notation. -Arguments Req The Req object. - Return value The tokens are returned as a list of case sensitive binary strings. -Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.path/</guid> + <description>Name cowboy_req:path - URI path +Description path(Req :: cowboy_req:req()) -&gt; Path :: binary() Return the path of the effective request URI. +The path can also be obtained using pattern matching: +#{path := Path} = Req. Arguments Req The Req object. + Return value The path is returned as a binary string. It is case sensitive. +Changelog 2.0: Only the path is returned, it is no longer wrapped in a tuple.</description> </item> <item> @@ -6423,17 +6644,17 @@ Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tup </item> <item> - <title>cowboy_req:peer(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.peer/</link> + <title>cowboy_req:path_info(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.path_info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.peer/</guid> - <description>Name cowboy_req:peer - Peer address and port -Description peer(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the peer&apos;s IP address and port number. -The peer information can also be obtained using pattern matching: -#{peer := {IP, Port}} = Req. Arguments Req The Req object. - Return value The peer&apos;s IP address and port number. -The peer is not necessarily the client&apos;s IP address and port. It is the IP address of the endpoint connecting directly to the server, which may be a gateway or a proxy.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.path_info/</guid> + <description>Name cowboy_req:path_info - Access the route&apos;s trailing path segments +Description path_info(Req :: cowboy_req:req()) -&gt; cowboy_router:tokens() Return the tokens for the trailing path segments. +This is the part of the host name that was matched using the ... notation. +Arguments Req The Req object. + Return value The tokens are returned as a list of case sensitive binary strings. +Changelog 2.0: Only the tokens are returned, they are no longer wrapped in a tuple.</description> </item> <item> @@ -6507,16 +6728,17 @@ The peer is not necessarily the client&apos;s IP address and port. It is the </item> <item> - <title>cowboy_req:port(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.port/</link> + <title>cowboy_req:peer(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.peer/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.port/</guid> - <description>Name cowboy_req:port - URI port number -Description port(Req :: cowboy_req:req()) -&gt; Port :: inet:port_number() Return the port number of the effective request URI. -Note that the port number returned by this function is obtained by parsing the host header. It may be different from the port the peer used to connect to Cowboy. -The port number can also be obtained using pattern matching: -#{port := Port} = Req. Arguments Req The Req object.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.peer/</guid> + <description>Name cowboy_req:peer - Peer address and port +Description peer(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the peer&apos;s IP address and port number. +The peer information can also be obtained using pattern matching: +#{peer := {IP, Port}} = Req. Arguments Req The Req object. + Return value The peer&apos;s IP address and port number. +The peer is not necessarily the client&apos;s IP address and port. It is the IP address of the endpoint connecting directly to the server, which may be a gateway or a proxy.</description> </item> <item> @@ -6585,14 +6807,16 @@ The port number can also be obtained using pattern matching: </item> <item> - <title>cowboy_req:push(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.push/</link> + <title>cowboy_req:port(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.port/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.push/</guid> - <description>Name cowboy_req:push - Push a resource to the client -Description push(Path, Headers, Req :: cowboy_req:req()) -&gt; push(Path, Headers, Req, #{}) push(Path, Headers, Req :: cowboy_req:req(), Opts) -&gt; ok Path :: iodata() %% case sensitive Headers :: cowboy:http_headers() Opts :: cowboy_req:push_opts() Push a resource to the client. -Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.port/</guid> + <description>Name cowboy_req:port - URI port number +Description port(Req :: cowboy_req:req()) -&gt; Port :: inet:port_number() Return the port number of the effective request URI. +Note that the port number returned by this function is obtained by parsing the host header. It may be different from the port the peer used to connect to Cowboy. +The port number can also be obtained using pattern matching: +#{port := Port} = Req. Arguments Req The Req object.</description> </item> <item> @@ -6651,17 +6875,14 @@ Cowboy handles push requests the same way as if they came from the client, inclu </item> <item> - <title>cowboy_req:qs(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.qs/</link> + <title>cowboy_req:push(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.push/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.qs/</guid> - <description>Name cowboy_req:qs - URI query string -Description qs(Req :: cowboy_req:req()) -&gt; Qs :: binary() Return the query string of the effective request URI. -The query string can also be obtained using pattern matching: -#{qs := Qs} = Req. Arguments Req The Req object. - Return value The query string is returned as a binary string. It is case sensitive. -Changelog 2.0: Only the query string is returned, it is no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.push/</guid> + <description>Name cowboy_req:push - Push a resource to the client +Description push(Path, Headers, Req :: cowboy_req:req()) -&gt; push(Path, Headers, Req, #{}) push(Path, Headers, Req :: cowboy_req:req(), Opts) -&gt; ok Path :: iodata() %% case sensitive Headers :: cowboy:http_headers() Opts :: cowboy_req:push_opts() Push a resource to the client. +Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.</description> </item> <item> @@ -6735,6 +6956,20 @@ Changelog 2.0: Only the query string is returned, it is no longer wrapped in a t </item> <item> + <title>cowboy_req:qs(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.qs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.qs/</guid> + <description>Name cowboy_req:qs - URI query string +Description qs(Req :: cowboy_req:req()) -&gt; Qs :: binary() Return the query string of the effective request URI. +The query string can also be obtained using pattern matching: +#{qs := Qs} = Req. Arguments Req The Req object. + Return value The query string is returned as a binary string. It is case sensitive. +Changelog 2.0: Only the query string is returned, it is no longer wrapped in a tuple.</description> + </item> + + <item> <title>cowboy_req:read_and_match_urlencoded_body(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/manual/cowboy_req.read_and_match_urlencoded_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -6779,14 +7014,14 @@ This function reads the request body and parses it as application/x-www-form-url </item> <item> - <title>cowboy_req:read_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_body/</link> + <title>cowboy_req:read_and_match_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_body/</guid> - <description>Name cowboy_req:read_body - Read the request body -Description read_body(Req :: cowboy_req:req()) -&gt; read_body(Req, #{}) read_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the request body. -This function reads a chunk of the request body. A more tuple is returned when more data remains to be read. Call the function repeatedly until an ok tuple is returned to read the entire body.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_and_match_urlencoded_body/</guid> + <description>Name cowboy_req:read_and_match_urlencoded_body - Read, parse and match a urlencoded request body against constraints +Description read_and_match_urlencoded_body(Fields, Req) -&gt; read_and_match_urlencoded_body(Fields, Req, #{}) read_and_match_urlencoded_body(Fields, Req, Opts) -&gt; {ok, Body, Req} Fields :: cowboy:fields() Req :: cowboy_req:req() Opts :: cowboy_req:read_body_opts() Body :: #{atom() =&gt; any()} Read, parse and match a urlencoded request body against constraints. +This function reads the request body and parses it as application/x-www-form-urlencoded. It then applies the given field constraints to the urlencoded data and returns the result as a map.</description> </item> <item> @@ -6845,14 +7080,14 @@ This function reads a chunk of the request body. A more tuple is returned when m </item> <item> - <title>cowboy_req:read_part(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_part/</link> + <title>cowboy_req:read_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_part/</guid> - <description>Name cowboy_req:read_part - Read the next multipart headers -Description read_part(Req :: cowboy_req:req()) -&gt; read_part(Req, #{}) read_part(Req :: cowboy_req:req(), Opts) -&gt; {ok, Headers, Req} | {done, Req} Opts :: cowboy_req:read_body_opts() Headers :: #{binary() =&gt; binary()} Read the next part of a multipart body. -This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function parses and returns headers.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_body/</guid> + <description>Name cowboy_req:read_body - Read the request body +Description read_body(Req :: cowboy_req:req()) -&gt; read_body(Req, #{}) read_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the request body. +This function reads a chunk of the request body. A more tuple is returned when more data remains to be read. Call the function repeatedly until an ok tuple is returned to read the entire body.</description> </item> <item> @@ -6911,14 +7146,14 @@ This function reads the request body and parses it as multipart. Each parts of a </item> <item> - <title>cowboy_req:read_part_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/</link> + <title>cowboy_req:read_part(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_part/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_part_body/</guid> - <description>Name cowboy_req:read_part_body - Read the current part&apos;s body -Description read_part_body(Req :: cowboy_req:req()) -&gt; read_part_body(Req, #{}) read_part_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the body of the current part of the multipart message. -This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function returns the body of the current part.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_part/</guid> + <description>Name cowboy_req:read_part - Read the next multipart headers +Description read_part(Req :: cowboy_req:req()) -&gt; read_part(Req, #{}) read_part(Req :: cowboy_req:req(), Opts) -&gt; {ok, Headers, Req} | {done, Req} Opts :: cowboy_req:read_body_opts() Headers :: #{binary() =&gt; binary()} Read the next part of a multipart body. +This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function parses and returns headers.</description> </item> <item> @@ -6977,15 +7212,14 @@ This function reads the request body and parses it as multipart. Each parts of a </item> <item> - <title>cowboy_req:read_urlencoded_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/</link> + <title>cowboy_req:read_part_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.read_urlencoded_body/</guid> - <description>Name cowboy_req:read_urlencoded_body - Read and parse a urlencoded request body -Description read_urlencoded_body(Req :: cowboy_req:req()) -&gt; read_urlencoded_body(Req, #{}) read_urlencoded_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Body, Req} Opts :: cowboy_req:read_body_opts() Body :: [{Key :: binary(), Value :: binary() | true}] Read and parse a urlencoded request body. -This function reads the request body and parses it as application/x-www-form-urlencoded. It returns a list of key/values. -The urlencoded media type is used by Web browsers when submitting HTML forms using the POST method.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_part_body/</guid> + <description>Name cowboy_req:read_part_body - Read the current part&apos;s body +Description read_part_body(Req :: cowboy_req:req()) -&gt; read_part_body(Req, #{}) read_part_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Data :: binary(), Req} | {more, Data :: binary(), Req} Opts :: cowboy_req:read_body_opts() Read the body of the current part of the multipart message. +This function reads the request body and parses it as multipart. Each parts of a multipart representation have their own headers and body. This function returns the body of the current part.</description> </item> <item> @@ -7049,14 +7283,15 @@ The urlencoded media type is used by Web browsers when submitting HTML forms usi </item> <item> - <title>cowboy_req:reply(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.reply/</link> + <title>cowboy_req:read_urlencoded_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.reply/</guid> - <description>Name cowboy_req:reply - Send the response -Description reply(Status, Req :: cowboy_req:req()) -&gt; reply(StatusCode, #{}, Req) reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req reply(Status, Headers, Body, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Body :: cowboy_req:resp_body() Send the response. -The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.read_urlencoded_body/</guid> + <description>Name cowboy_req:read_urlencoded_body - Read and parse a urlencoded request body +Description read_urlencoded_body(Req :: cowboy_req:req()) -&gt; read_urlencoded_body(Req, #{}) read_urlencoded_body(Req :: cowboy_req:req(), Opts) -&gt; {ok, Body, Req} Opts :: cowboy_req:read_body_opts() Body :: [{Key :: binary(), Value :: binary() | true}] Read and parse a urlencoded request body. +This function reads the request body and parses it as application/x-www-form-urlencoded. It returns a list of key/values. +The urlencoded media type is used by Web browsers when submitting HTML forms using the POST method.</description> </item> <item> @@ -7115,15 +7350,14 @@ The header names must be given as lowercase binary strings. While header names a </item> <item> - <title>cowboy_req:resp_header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/</link> + <title>cowboy_req:reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.reply/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.resp_header/</guid> - <description>Name cowboy_req:resp_header - Response header -Description resp_header(Name, Req) -&gt; resp_header(Name, Req, undefined) resp_header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given response header. -The response header must have been set previously using cowboy_req:set_resp_header(3) or cowboy_req:set_resp_headers(3). -The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.reply/</guid> + <description>Name cowboy_req:reply - Send the response +Description reply(Status, Req :: cowboy_req:req()) -&gt; reply(StatusCode, #{}, Req) reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req reply(Status, Headers, Body, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Body :: cowboy_req:resp_body() Send the response. +The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> </item> <item> @@ -7187,16 +7421,15 @@ The header name must be given as a lowercase binary string. While header names a </item> <item> - <title>cowboy_req:resp_headers(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/</link> + <title>cowboy_req:resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.resp_headers/</guid> - <description>Name cowboy_req:resp_headers - Response headers -Description resp_headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all response headers. -Arguments Req The Req object. - Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. -Changelog 2.0: Function introduced. Examples Get all response headers Headers = cowboy_req:resp_headers(Req). See also cowboy_req(3), cowboy_req:resp_header(3), cowboy_req:set_resp_header(3), cowboy_req:set_resp_headers(3)</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.resp_header/</guid> + <description>Name cowboy_req:resp_header - Response header +Description resp_header(Name, Req) -&gt; resp_header(Name, Req, undefined) resp_header(Name, Req, Default) -&gt; binary() | Default Name :: binary() %% lowercase; case insensitive Req :: cowboy_req:req() Default :: any() Return the value for the given response header. +The response header must have been set previously using cowboy_req:set_resp_header(3) or cowboy_req:set_resp_headers(3). +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.</description> </item> <item> @@ -7265,18 +7498,16 @@ Changelog 2.0: Function introduced. Examples Get all response headers Headers </item> <item> - <title>cowboy_req:scheme(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.scheme/</link> + <title>cowboy_req:resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.scheme/</guid> - <description>Name cowboy_req:scheme - URI scheme -Description scheme(Req :: cowboy_req:req()) -&gt; Scheme :: binary() Return the scheme of the effective request URI. -The scheme can also be obtained using pattern matching: -#{scheme := Scheme} = Req. Arguments Req The Req object. - Return value The scheme is returned as a binary. It is case insensitive. -Cowboy will only set the scheme to &lt;&lt;&quot;http&quot;&gt;&gt; or &lt;&lt;&quot;https&quot;&gt;&gt;. -Changelog 2.0: Function introduced.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.resp_headers/</guid> + <description>Name cowboy_req:resp_headers - Response headers +Description resp_headers(Req :: cowboy_req:req()) -&gt; cowboy:http_headers() Return all response headers. +Arguments Req The Req object. + Return value Headers are returned as a map with keys being lowercase binary strings, and values as binary strings. +Changelog 2.0: Function introduced. Examples Get all response headers Headers = cowboy_req:resp_headers(Req). See also cowboy_req(3), cowboy_req:resp_header(3), cowboy_req:set_resp_header(3), cowboy_req:set_resp_headers(3)</description> </item> <item> @@ -7355,15 +7586,18 @@ Changelog 2.0: Function introduced.</description> </item> <item> - <title>cowboy_req:set_resp_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/</link> + <title>cowboy_req:scheme(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.scheme/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_body/</guid> - <description>Name cowboy_req:set_resp_body - Set the response body -Description set_resp_body(Body, Req :: cowboy_req:req()) -&gt; Req Body :: cowboy_req:resp_body() Set the response body. -The response body will be sent when a reply is initiated. Note that the functions stream_reply/2,3 and reply/4 will override the body set by this function. -This function can also be used to remove a response body that was set previously. To do so, simply call this function with an empty body.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.scheme/</guid> + <description>Name cowboy_req:scheme - URI scheme +Description scheme(Req :: cowboy_req:req()) -&gt; Scheme :: binary() Return the scheme of the effective request URI. +The scheme can also be obtained using pattern matching: +#{scheme := Scheme} = Req. Arguments Req The Req object. + Return value The scheme is returned as a binary. It is case insensitive. +Cowboy will only set the scheme to &lt;&lt;&quot;http&quot;&gt;&gt; or &lt;&lt;&quot;https&quot;&gt;&gt;. +Changelog 2.0: Function introduced.</description> </item> <item> @@ -7427,17 +7661,15 @@ This function can also be used to remove a response body that was set previously </item> <item> - <title>cowboy_req:set_resp_cookie(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/</link> + <title>cowboy_req:set_resp_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_cookie/</guid> - <description>Name cowboy_req:set_resp_cookie - Set a cookie -Description set_resp_cookie(Name, Value, Req :: cowboy_req:req()) -&gt; set_resp_cookie(Name, Value, [], Req) set_resp_cookie(Name, Value, Req :: cowboy_req:req(), Opts) -&gt; Req Name :: binary() %% case sensitive Value :: iodata() %% case sensitive Opts :: cow_cookie:cookie_opts() Set a cookie to be sent with the response. -Note that cookie names are case sensitive. -Arguments Name Cookie name. - Value Cookie value. - Req The Req object.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_body/</guid> + <description>Name cowboy_req:set_resp_body - Set the response body +Description set_resp_body(Body, Req :: cowboy_req:req()) -&gt; Req Body :: cowboy_req:resp_body() Set the response body. +The response body will be sent when a reply is initiated. Note that the functions stream_reply/2,3 and reply/4 will override the body set by this function. +This function can also be used to remove a response body that was set previously. To do so, simply call this function with an empty body.</description> </item> <item> @@ -7511,15 +7743,17 @@ Arguments Name Cookie name. </item> <item> - <title>cowboy_req:set_resp_header(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/</link> + <title>cowboy_req:set_resp_cookie(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_header/</guid> - <description>Name cowboy_req:set_resp_header - Set a response header -Description set_resp_header(Name, Value, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Value :: iodata() %% case depends on header Set a header to be sent with the response. -The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Cowboy does not allow duplicate header names.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_cookie/</guid> + <description>Name cowboy_req:set_resp_cookie - Set a cookie +Description set_resp_cookie(Name, Value, Req :: cowboy_req:req()) -&gt; set_resp_cookie(Name, Value, Req, #{}) set_resp_cookie(Name, Value, Req :: cowboy_req:req(), Opts) -&gt; Req Name :: binary() %% case sensitive Value :: iodata() %% case sensitive Opts :: cow_cookie:cookie_opts() Set a cookie to be sent with the response. +Note that cookie names are case sensitive. +Arguments Name Cookie name. + Value Cookie value. + Req The Req object.</description> </item> <item> @@ -7583,15 +7817,15 @@ Cowboy does not allow duplicate header names.</description> </item> <item> - <title>cowboy_req:set_resp_headers(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/</link> + <title>cowboy_req:set_resp_header(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.set_resp_headers/</guid> - <description>Name cowboy_req:set_resp_headers - Set several response headers -Description set_resp_headers(Headers, Req :: cowboy_req:req()) -&gt; Req Headers :: cowboy:http_headers() Set several headers to be sent with the response. + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_header/</guid> + <description>Name cowboy_req:set_resp_header - Set a response header +Description set_resp_header(Name, Value, Req :: cowboy_req:req()) -&gt; Req Name :: binary() %% lowercase; case insensitive Value :: iodata() %% case depends on header Set a header to be sent with the response. The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions.</description> +Cowboy does not allow duplicate header names.</description> </item> <item> @@ -7655,17 +7889,15 @@ Cowboy does not allow duplicate header names. Headers set by this function may b </item> <item> - <title>cowboy_req:sock(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.sock/</link> + <title>cowboy_req:set_resp_headers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.sock/</guid> - <description>Name cowboy_req:sock - Socket address and port -Description sock(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the socket&apos;s IP address and port number. -The socket information can also be obtained using pattern matching: -#{sock := {IP, Port}} = Req. Arguments Req The Req object. - Return value The socket&apos;s local IP address and port number. -Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP address and port number.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.set_resp_headers/</guid> + <description>Name cowboy_req:set_resp_headers - Set several response headers +Description set_resp_headers(Headers, Req :: cowboy_req:req()) -&gt; Req Headers :: cowboy:http_headers() Set several headers to be sent with the response. +The header name must be given as a lowercase binary string. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Cowboy does not allow duplicate header names. Headers set by this function may be overwritten by those set from the reply functions.</description> </item> <item> @@ -7739,15 +7971,17 @@ Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP addr </item> <item> - <title>cowboy_req:stream_body(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/</link> + <title>cowboy_req:sock(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.sock/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_body/</guid> - <description>Name cowboy_req:stream_body - Stream the response body -Description stream_body(Data, IsFin, Req :: cowboy_req:req()) -&gt; ok Data :: iodata() IsFin :: fin | nofin Stream the response body. -This function may be called as many times as needed after initiating a response using the cowboy_req:stream_reply(3) function. -The second argument indicates if this call is the final call. Use the nofin value until you know no more data will be sent. The final call should use fin (possibly with an empty data value) or be a call to the cowboy_req:stream_trailers(3) function.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.sock/</guid> + <description>Name cowboy_req:sock - Socket address and port +Description sock(Req :: cowboy_req:req()) -&gt; Info Info :: {inet:ip_address(), inet:port_number()} Return the socket&apos;s IP address and port number. +The socket information can also be obtained using pattern matching: +#{sock := {IP, Port}} = Req. Arguments Req The Req object. + Return value The socket&apos;s local IP address and port number. +Changelog 2.1: Function introduced. Examples Get the socket&apos;s IP address and port number.</description> </item> <item> @@ -7811,6 +8045,18 @@ The second argument indicates if this call is the final call. Use the nofin valu </item> <item> + <title>cowboy_req:stream_body(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_body/</guid> + <description>Name cowboy_req:stream_body - Stream the response body +Description stream_body(Data, IsFin, Req :: cowboy_req:req()) -&gt; ok Data :: cowboy_req:resp_body() IsFin :: fin | nofin Stream the response body. +This function may be called as many times as needed after initiating a response using the cowboy_req:stream_reply(3) function. +The second argument indicates if this call is the final call. Use the nofin value until you know no more data will be sent. The final call should use fin (possibly with an empty data value) or be a call to the cowboy_req:stream_trailers(3) function.</description> + </item> + + <item> <title>cowboy_req:stream_events(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.5/manual/cowboy_req.stream_events/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7855,15 +8101,14 @@ This function should only be used for text/event-stream responses when using ser </item> <item> - <title>cowboy_req:stream_reply(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/</link> + <title>cowboy_req:stream_events(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_reply/</guid> - <description>Name cowboy_req:stream_reply - Send the response headers -Description stream_reply(Status, Req :: cowboy_req:req()) -&gt; stream_reply(StatusCode, #{}, Req) stream_reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send the response headers. -The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. -Cowboy does not allow duplicate header names. Headers set by this function may overwrite those set by set_resp_header/3.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_events/</guid> + <description>Name cowboy_req:stream_events - Stream events +Description stream_events(Events, IsFin, Req :: cowboy_req:req()) -&gt; ok Events :: Event | [Event] IsFin :: fin | nofin Event :: #{ comment =&gt; iodata(), data =&gt; iodata(), event =&gt; iodata() | atom(), id =&gt; iodata(), retry =&gt; non_neg_integer() } Stream events. +This function should only be used for text/event-stream responses when using server-sent events. Cowboy will automatically encode the given events to their text representation.</description> </item> <item> @@ -7927,15 +8172,15 @@ Cowboy does not allow duplicate header names. Headers set by this function may o </item> <item> - <title>cowboy_req:stream_trailers(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/</link> + <title>cowboy_req:stream_reply(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.stream_trailers/</guid> - <description>Name cowboy_req:stream_trailers - Send the response trailers -Description stream_trailers(Trailers, Req :: cowboy_req:req()) -&gt; ok Trailers :: cowboy:http_headers() Send the response trailers and terminate the stream. -This function can only be called once, after initiating a response using cowboy_req:stream_reply(3) and sending zero or more body chunks using cowboy_req:stream_body(3) with the nofin argument set. The function stream_trailers/2 implies fin and automatically terminate the response. -You must list all field names sent in trailers in the trailer header, otherwise they might be dropped by intermediaries or clients.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_reply/</guid> + <description>Name cowboy_req:stream_reply - Send the response headers +Description stream_reply(Status, Req :: cowboy_req:req()) -&gt; stream_reply(StatusCode, #{}, Req) stream_reply(Status, Headers, Req :: cowboy_req:req()) -&gt; Req Status :: cowboy:http_status() Headers :: cowboy:http_headers() Send the response headers. +The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly. +Cowboy does not allow duplicate header names. Headers set by this function may overwrite those set by set_resp_header/3.</description> </item> <item> @@ -7999,14 +8244,15 @@ You must list all field names sent in trailers in the trailer header, otherwise </item> <item> - <title>cowboy_req:uri(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.uri/</link> + <title>cowboy_req:stream_trailers(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.uri/</guid> - <description>Name cowboy_req:uri - Reconstructed URI -Description uri(Req :: cowboy_req:req()) -&gt; uri(Req, #{}) uri(Req :: cowboy_req:req(), Opts) -&gt; URI :: iodata() Opts :: #{ scheme =&gt; iodata() | undefined, host =&gt; iodata() | undefined, port =&gt; inet:port_number() | undefined, path =&gt; iodata() | undefined, qs =&gt; iodata() | undefined, fragment =&gt; iodata() | undefined } Reconstruct the effective request URI, optionally modifying components. -By default Cowboy will build a URI using the components found in the request.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.stream_trailers/</guid> + <description>Name cowboy_req:stream_trailers - Send the response trailers +Description stream_trailers(Trailers, Req :: cowboy_req:req()) -&gt; ok Trailers :: cowboy:http_headers() Send the response trailers and terminate the stream. +This function can only be called once, after initiating a response using cowboy_req:stream_reply(3) and sending zero or more body chunks using cowboy_req:stream_body(3) with the nofin argument set. The function stream_trailers/2 implies fin and automatically terminate the response. +You must list all field names sent in trailers in the trailer header, otherwise they might be dropped by intermediaries or clients.</description> </item> <item> @@ -8065,17 +8311,14 @@ By default Cowboy will build a URI using the components found in the request.</d </item> <item> - <title>cowboy_req:version(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.version/</link> + <title>cowboy_req:uri(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.uri/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_req.version/</guid> - <description>Name cowboy_req:version - HTTP version -Description version(Req :: cowboy_req:req()) -&gt; Version :: cowboy:http_version() Return the HTTP version used for the request. -The version can also be obtained using pattern matching: -#{version := Version} = Req. Arguments Req The Req object. - Return value The HTTP version used for the request is returned as an atom. It is provided for informative purposes only. -Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.uri/</guid> + <description>Name cowboy_req:uri - Reconstructed URI +Description uri(Req :: cowboy_req:req()) -&gt; uri(Req, #{}) uri(Req :: cowboy_req:req(), Opts) -&gt; URI :: iodata() Opts :: #{ scheme =&gt; iodata() | undefined, host =&gt; iodata() | undefined, port =&gt; inet:port_number() | undefined, path =&gt; iodata() | undefined, qs =&gt; iodata() | undefined, fragment =&gt; iodata() | undefined } Reconstruct the effective request URI, optionally modifying components. +By default Cowboy will build a URI using the components found in the request.</description> </item> <item> @@ -8149,16 +8392,17 @@ Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple. </item> <item> - <title>cowboy_rest(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_rest/</link> + <title>cowboy_req:version(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.version/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_rest/</guid> - <description>Name cowboy_rest - REST handlers -Description The module cowboy_rest implements the HTTP state machine. -Implementing REST handlers is not enough to provide a REST interface; this interface must also follow the REST constraints including HATEOAS (hypermedia as the engine of application state). -Callbacks REST handlers implement the following interface: -init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -&gt; {Result, Req, State} | {stop, Req, State} | {{switch_handler, Module}, Req, State} | {{switch_handler, Module, Opts}, Req, State} terminate(Reason, Req, State) -&gt; ok %% optional Req :: cowboy_req:req() State :: any() Module :: module() Opts :: any() Reason :: normal | {crash, error | exit | throw, any()} Callback - see below Result - see below Default - see below The init/2 callback is common to all handlers.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_req.version/</guid> + <description>Name cowboy_req:version - HTTP version +Description version(Req :: cowboy_req:req()) -&gt; Version :: cowboy:http_version() Return the HTTP version used for the request. +The version can also be obtained using pattern matching: +#{version := Version} = Req. Arguments Req The Req object. + Return value The HTTP version used for the request is returned as an atom. It is provided for informative purposes only. +Changelog 2.0: Only the version is returned, it is no longer wrapped in a tuple.</description> </item> <item> @@ -8227,16 +8471,16 @@ init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -& </item> <item> - <title>cowboy_router(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_router/</link> + <title>cowboy_rest(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_rest/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_router/</guid> - <description>Name cowboy_router - Router middleware -Description The cowboy_router middleware maps the requested host and path to the handler to be used for processing the request. -The router takes the dispatch rules as input from the middleware environment. Dispatch rules are generated by calling the cowboy_router:compile(3) function. -When a route matches, the router sets the handler and handler_opts middleware environment values containing the handler module and initial state, respectively. -The router will stop execution when no route matches.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_rest/</guid> + <description>Name cowboy_rest - REST handlers +Description The module cowboy_rest implements the HTTP state machine. +Implementing REST handlers is not enough to provide a REST interface; this interface must also follow the REST constraints including HATEOAS (hypermedia as the engine of application state). +Callbacks REST handlers implement the following interface: +init(Req, State) -&gt; {cowboy_rest, Req, State} Callback(Req, State) -&gt; {Result, Req, State} | {stop, Req, State} | {{switch_handler, Module}, Req, State} | {{switch_handler, Module, Opts}, Req, State} terminate(Reason, Req, State) -&gt; ok %% optional Req :: cowboy_req:req() State :: any() Module :: module() Opts :: any() Reason :: normal | {crash, error | exit | throw, any()} Callback - see below Result - see below Default - see below The init/2 callback is common to all handlers.</description> </item> <item> @@ -8301,17 +8545,14 @@ The router takes the dispatch rules as input from the middleware environment. Di </item> <item> - <title>cowboy_router:compile(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_router.compile/</link> + <title>cowboy_router(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_router/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_router.compile/</guid> - <description>Name cowboy_router:compile - Compile routes to the resources -Description compile(cowboy_router:routes()) -&gt; cowboy_router:dispatch_rules() Compile routes to the resources. -Takes a human readable list of routes and transforms it into a form more efficient to process. -Arguments Routes Human readable list of routes. - Return value An opaque dispatch rules value is returned. This value must be given to Cowboy as a middleware environment value. -Changelog 1.0: Function introduced. Examples Compile routes and start a listener Dispatch = cowboy_router:compile([ {'_', [ {"</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_router/</guid> + <description>Name cowboy_router - Router middleware +Description The cowboy_router middleware maps the requested host and path to the handler to be used for processing the request. +The router takes the dispatch rules as input from the middleware environment. Dispatch rules are generated by calling the cowboy_router:compile(3) function. The environment can contain the rules directly or a tuple {persistent_term, Key}, in which case Cowboy will call persistent_term:get(Key) to retrieve the dispatch rules.</description> </item> <item> @@ -8385,15 +8626,17 @@ Changelog 1.0: Function introduced. Examples Compile routes and start a listen </item> <item> - <title>cowboy_static(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_static/</link> + <title>cowboy_router:compile(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_router.compile/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_static/</guid> - <description>Name cowboy_static - Static file handler -Description The module cowboy_static implements file serving capabilities using the REST semantics provided by cowboy_rest. -The static file handler is a pre-written handler coming with Cowboy. To serve files, use it in your routes. -Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file, Path} | {file, Path, Extra} | {priv_dir, App, Path} | {priv_dir, App, Path, Extra} | {dir, Path} | {dir, Path, Extra} App :: atom() Path :: binary() | string() Extra :: [Etag | Mimetypes] Etag :: {etag, module(), function()} | {etag, false} Mimetypes :: {mimetypes, module(), function()} | {mimetypes, binary() | ParsedMime} ParsedMime :: {Type :: binary(), SubType :: binary(), Params} Params :: [{Key :: binary(), Value :: binary()}] Static handler configuration.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_router.compile/</guid> + <description>Name cowboy_router:compile - Compile routes to the resources +Description compile(cowboy_router:routes()) -&gt; cowboy_router:dispatch_rules() Compile routes to the resources. +Takes a human readable list of routes and transforms it into a form more efficient to process. +Arguments Routes Human readable list of routes. + Return value An opaque dispatch rules value is returned. This value must be given to Cowboy as a middleware environment value. +Changelog 1.0: Function introduced. Examples Compile routes and start a listener Dispatch = cowboy_router:compile([ {'_', [ {"</description> </item> <item> @@ -8457,16 +8700,15 @@ Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file </item> <item> - <title>cowboy_stream(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_stream/</link> + <title>cowboy_static(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_static/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_stream/</guid> - <description>Name cowboy_handler - Stream handlers -Description The module cowboy_stream defines a callback interface and a protocol for handling HTTP streams. -An HTTP request and its associated response is called a stream. A connection may have many streams. In HTTP/1.1 they are executed sequentially, while in HTTP/2 they are executed concurrently. -Cowboy calls the stream handler for nearly all events related to a stream. Exceptions vary depending on the protocol. -Extra care must be taken when implementing stream handlers to ensure compatibility.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_static/</guid> + <description>Name cowboy_static - Static file handler +Description The module cowboy_static implements file serving capabilities using the REST semantics provided by cowboy_rest. +The static file handler is a pre-written handler coming with Cowboy. To serve files, use it in your routes. +Options opts() :: {priv_file, App, Path} | {priv_file, App, Path, Extra} | {file, Path} | {file, Path, Extra} | {priv_dir, App, Path} | {priv_dir, App, Path, Extra} | {dir, Path} | {dir, Path, Extra} App :: atom() Path :: binary() | string() Extra :: [Charset | Etag | Mimetypes] Charset :: {charset, module(), function()} | {charset, binary()} Etag :: {etag, module(), function()} | {etag, false} Mimetypes :: {mimetypes, module(), function()} | {mimetypes, binary() | ParsedMime} ParsedMime :: {Type :: binary(), SubType :: binary(), Params} Params :: [{Key :: binary(), Value :: binary()}] Static handler configuration.</description> </item> <item> @@ -8535,6 +8777,19 @@ Extra care must be taken when implementing stream handlers to ensure compatibili </item> <item> + <title>cowboy_stream(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_stream/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_stream/</guid> + <description>Name cowboy_stream - Stream handlers +Description The module cowboy_stream defines a callback interface and a protocol for handling HTTP streams. +An HTTP request and its associated response is called a stream. A connection may have many streams. In HTTP/1.1 they are executed sequentially, while in HTTP/2 they are executed concurrently. +Cowboy calls the stream handler for nearly all events related to a stream. Exceptions vary depending on the protocol. +Extra care must be taken when implementing stream handlers to ensure compatibility.</description> + </item> + + <item> <title>cowboy_stream_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.6/manual/cowboy_stream_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8571,6 +8826,18 @@ The default value is given next to the option name:</description> </item> <item> + <title>cowboy_stream_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_stream_h/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_stream_h/</guid> + <description>Name cowboy_stream_h - Default stream handler +Description The module cowboy_stream_h is Cowboy&apos;s default stream handler and defines much of its behavior. It is responsible for managing the request process, sending it the request body and translating its messages into commands that Cowboy understands. +Options opts() :: #{ env =&gt; cowboy_middleware:env(), middlewares =&gt; [module()], shutdown_timeout =&gt; timeout() } Configuration for the default stream handler. +The default value is given next to the option name:</description> + </item> + + <item> <title>cowboy_tracer_h(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.7/manual/cowboy_tracer_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8593,15 +8860,14 @@ Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; </item> <item> - <title>cowboy_websocket(3)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_websocket/</link> + <title>cowboy_tracer_h(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_tracer_h/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/cowboy_websocket/</guid> - <description>Name cowboy_websocket - Websocket -Description The module cowboy_websocket implements Websocket as a Ranch protocol. It also defines a callback interface for handling Websocket connections. -Callbacks Websocket handlers must implement the following callback interface: -init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, Req, State, Opts} websocket_init(State) -&gt; CallResult %% optional websocket_handle(InFrame, State) -&gt; CallResult websocket_info(Info, State) -&gt; CallResult terminate(Reason, PartialReq, State) -&gt; ok %% optional Req :: cowboy_req:req() PartialReq :: map() State :: any() Opts :: cowboy_websocket:opts() InFrame :: {text | binary | ping | pong, binary()} OutFrame :: cow_ws:frame() %% see types below Info :: any() CallResult :: {ok, State} | {ok, State, hibernate} | {reply, OutFrame | [OutFrame], State} | {reply, OutFrame | [OutFrame], State, hibernate} | {stop, State} Reason :: normal | stop | timeout | remote | {remote, cow_ws:close_code(), binary()} | {error, badencoding | badframe | closed | atom()} | {crash, error | exit | throw, any()} The init/2 callback is common to all handlers.</description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_tracer_h/</guid> + <description>Name cowboy_tracer_h - Tracer stream handler +Description The module cowboy_tracer_h can be used to conditionally trace streams based on information found in the request. Trace messages are given to the configured callback. +Options opts() :: #{ tracer_callback =&gt; Callback, tracer_flags =&gt; [atom()], tracer_match_specs =&gt; [MatchSpec] } Callback :: fun((init | terminate | tuple(), State) -&gt; State) MatchSpec :: MatchPredicate | {method, binary()} | {host, binary()} | {path, binary()} | {path_start, binary()} | {header, binary()} | {header, binary(), binary()} | {peer_ip, inet:ip_address()} MatchPredicate :: fun((cowboy_stream:streamid(), cowboy_req:req(), cowboy:opts()) -&gt; boolean()) } Configuration for the tracer stream handler.</description> </item> <item> @@ -8665,6 +8931,18 @@ init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, R </item> <item> + <title>cowboy_websocket(3)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/cowboy_websocket/</guid> + <description>Name cowboy_websocket - Websocket +Description The module cowboy_websocket implements Websocket as a Ranch protocol. It also defines a callback interface for handling Websocket connections. +Callbacks Websocket handlers must implement the following callback interface: +init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, Req, State, Opts} websocket_init(State) -&gt; CallResult %% optional websocket_handle(InFrame, State) -&gt; CallResult websocket_info(Info, State) -&gt; CallResult terminate(Reason, PartialReq, State) -&gt; ok %% optional Req :: cowboy_req:req() PartialReq :: map() State :: any() Opts :: cowboy_websocket:opts() InFrame :: ping | pong | {text | binary | ping | pong, binary()} Info :: any() CallResult :: {commands(), State} | {commands(), State, hibernate} | Deprecated Deprecated :: {ok, State} | {ok, State, hibernate} | {reply, OutFrame | [OutFrame], State} | {reply, OutFrame | [OutFrame], State, hibernate} | {stop, State} OutFrame :: cow_ws:frame() %% see types below Reason :: normal | stop | timeout | remote | {remote, cow_ws:close_code(), binary()} | {error, badencoding | badframe | closed | atom()} | {crash, error | exit | throw, any()} The init/2 callback is common to all handlers.</description> + </item> + + <item> <title>Cowlib Function Reference</title> <link>https://ninenines.eu/docs/en/cowlib/2.10/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8678,6 +8956,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>Cowlib Function Reference</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>Cowlib Function Reference</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8714,6 +9004,18 @@ Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All t <item> <title>cowlib(7)</title> + <link>https://ninenines.eu/docs/en/cowlib/2.11/manual/cowlib_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.11/manual/cowlib_app/</guid> + <description>Name cowlib - Support library for manipulating Web protocols +Description Cowlib provides libraries for parsing and building messages for various Web protocols, including HTTP/1.1, HTTP/2 and Websocket. +It is optimized for completeness rather than speed. No value is ignored, they are all returned. +Modules cow_cookie(3) - Cookies Dependencies crypto - Crypto functions All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:</description> + </item> + + <item> + <title>cowlib(7)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cowlib_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -10829,7 +11131,7 @@ Gun will now start processing the messages it received while waiting for the con <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_up/</guid> <description>Name gun_up - The connection is up -Description {gun_up, ConnPid, Protocol} ConnPid :: pid() Protocol :: http | http2 | socks The connection is up. +Description {gun_up, ConnPid, Protocol} ConnPid :: pid() Protocol :: http | http2 | raw | socks The connection is up. This message informs the owner process that the connection or reconnection completed. If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow. Otherwise, Gun will start processing the messages it received while waiting for the connection to be up.</description> @@ -10961,17 +11263,6 @@ This message can only be sent on streams that were upgraded to the Websocket pro <item> <title>HTTP status codes(7)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.3/manual/http_status_codes/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.3/manual/http_status_codes/</guid> - <description>Name HTTP status codes - status codes used by Cowboy -Description This chapter aims to list all HTTP status codes that Cowboy may return, with details on the reasons why. The list given here only includes the replies that Cowboy sends, not user replies. -100 Continue When the client sends an expect: 100-continue header, Cowboy automatically sends a this status code before trying to read the request body. This behavior can be disabled using the appropriate body option.</description> - </item> - - <item> - <title>HTTP status codes(7)</title> <link>https://ninenines.eu/docs/en/cowboy/2.4/manual/http_status_codes/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11026,12 +11317,14 @@ 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.4/manual/</link> + <title>HTTP status codes(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.9/manual/http_status_codes/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/manual/</guid> - <description>ranch(7) ranch(3) ranch_protocol(3) ranch_ssl(3) ranch_tcp(3) ranch_transport(3) </description> + <guid>https://ninenines.eu/docs/en/cowboy/2.9/manual/http_status_codes/</guid> + <description>Name HTTP status codes - status codes used by Cowboy +Description This chapter aims to list all HTTP status codes that Cowboy may return, with details on the reasons why. The list given here only includes the replies that Cowboy sends, not user replies. +100 Continue When the client sends an expect: 100-continue header, Cowboy automatically sends a this status code before trying to read the request body. This behavior can be disabled using the appropriate body option.</description> </item> <item> @@ -11073,10 +11366,10 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <item> <title>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. @@ -11086,12 +11379,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.4/guide/</link> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/guide/</guid> - <description>Introduction Listeners Transports Protocols Embedded mode Writing parsers SSL client authentication Internals </description> + <guid>https://ninenines.eu/docs/en/ranch/2.0/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> @@ -11123,24 +11421,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <item> <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/guide/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/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 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> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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.7 to 1.8 Migrating from Ranch 1.6 to 1.7 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> </item> <item> - <title>ranch(3)</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/manual/ranch/</link> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/guide/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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 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> @@ -11186,29 +11480,30 @@ ranch:accept_ack(3) - Deprecated in favor of ranch:handshake(3) ranch:handshake <item> <title>ranch(3)</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> +ranch:accept_ack(3) - Deprecated in favor of ranch:handshake(3) ranch:handshake(3) - Perform the 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> - <title>ranch(7)</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/manual/ranch_app/</link> + <title>ranch(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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> @@ -11254,6 +11549,20 @@ ranch_ssl(3) - SSL transport ranch_tcp(3) - TCP transport Behaviors:</descrip <item> <title>ranch(7)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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(7)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11292,6 +11601,18 @@ Arguments Ref The listener name is used to refer to this listener in future call <item> <title>ranch:child_spec(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.child_spec/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. +This function can be used to embed a listener directly in an application&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:child_spec(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.child_spec/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11332,6 +11653,20 @@ Examples Get the listening port and IP {IP, Port} = ranch:get_addr(example).</de <item> <title>ranch:get_addr(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_addr/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_addr/</guid> + <description>Name ranch:get_addr - Get the listening port and IP +Description get_addr(Ref :: ranch:ref()) -&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_addr(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_addr/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11370,6 +11705,19 @@ Examples Get the max number of connections MaxConns = ranch:get_max_connections( <item> <title>ranch:get_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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()) -&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_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11411,6 +11759,20 @@ Examples Get the listening port Port = ranch:get_port(example). See also ranch: <item> <title>ranch:get_port(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_port/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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() 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_port(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_port/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11451,6 +11813,19 @@ Examples Get the current protocol options ProtoOpts = ranch:get_protocol_options <item> <title>ranch:get_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11490,6 +11865,19 @@ Changelog 1.6: Function introduced. Examples Get a listener&apos;s running <item> <title>ranch:get_status(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_status/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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_status(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_status/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11529,6 +11917,19 @@ Examples Get the current transport options TransOpts = ranch:get_transport_optio <item> <title>ranch:get_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.get_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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 :: 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:get_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.get_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11564,6 +11965,17 @@ This function must be called by the protocol process in order to retrieve the so <item> <title>ranch:handshake(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.handshake/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.handshake/</guid> + <description>Name ranch:handshake - Perform the transport handshake +Description handshake(Ref) -&gt; handshake(Ref, []) handshake(Ref, Opts) -&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:handshake(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.handshake/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11635,6 +12047,21 @@ pid Pid of the listener&apos;s top-level supervisor. <item> <title>ranch:info(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:info(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11678,6 +12105,20 @@ Examples Get the pids of the acceptor processes Pids = ranch:procs(acceptors). <item> <title>ranch:procs(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.procs/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:procs(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.procs/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11706,6 +12147,20 @@ Arguments Ref The listener name. <item> <title>ranch:recv_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.recv_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:recv_proxy_header(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.recv_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11744,6 +12199,18 @@ This function may only be called from a connection process.</description> <item> <title>ranch:remove_connection(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.remove_connection/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:remove_connection(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.remove_connection/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11784,6 +12251,20 @@ Arguments Ref The listener name. <item> <title>ranch:resume_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.resume_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:resume_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.resume_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11822,6 +12303,18 @@ Arguments Ref The listener name.</description> <item> <title>ranch:set_max_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.set_max_connections/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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()) -&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_max_connections(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.set_max_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11863,6 +12356,21 @@ Examples Set the protocol options ranch:set_protocol_options(example, ProtoOpts) <item> <title>ranch:set_protocol_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.set_protocol_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. +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_protocol_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.set_protocol_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11908,6 +12416,21 @@ Arguments Ref The listener name. <item> <title>ranch:set_transport_options(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.set_transport_options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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()) -&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:set_transport_options(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.set_transport_options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11944,6 +12467,18 @@ Arguments Ref The listener name is used to refer to this listener in future call <item> <title>ranch:start_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.start_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:start_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.start_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -11980,6 +12515,18 @@ In order for the connection processes to exit gracefully, they need to trap exit <item> <title>ranch:stop_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.stop_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:stop_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.stop_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12016,6 +12563,18 @@ Some transport options can only be changed when the listener is suspended. Pleas <item> <title>ranch:suspend_listener(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.suspend_listener/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:suspend_listener(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.suspend_listener/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12052,10 +12611,10 @@ This function can be used to gracefully shutdown a listener by first suspending <item> <title>ranch:wait_for_connections(3)</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.wait_for_connections/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch.wait_for_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.wait_for_connections/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. @@ -12063,19 +12622,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.4/manual/ranch_protocol/</link> + <title>ranch:wait_for_connections(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch.wait_for_connections/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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> @@ -12122,6 +12677,19 @@ The only purpose of this callback is to start a process that will handle the soc <item> <title>ranch_protocol(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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_protocol(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_protocol/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12146,6 +12714,17 @@ Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header ranch_proxy <item> <title>ranch_proxy_header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_proxy_header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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 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(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_proxy_header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12170,6 +12749,19 @@ Arguments ProxyInfo The proxy information to encode. <item> <title>ranch_proxy_header:header(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_proxy_header.header/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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:header(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_proxy_header.header/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12196,10 +12788,10 @@ An error tuple is returned when a protocol error is detected.</description> <item> <title>ranch_proxy_header:parse(3)</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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. @@ -12208,14 +12800,16 @@ 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.4/manual/ranch_ssl/</link> + <title>ranch_proxy_header:parse(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_proxy_header.parse/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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> @@ -12261,29 +12855,32 @@ ssl_opt() ssl_opt() = {alpn_preferred_protocols, [binary()]} | {beast_mitigation <item> <title>ranch_ssl(3)</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_ssl/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_ssl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_ssl/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> +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.4/manual/ranch_tcp/</link> + <title>ranch_ssl(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_ssl/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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> @@ -12326,30 +12923,28 @@ Types opt() opt() = {backlog, non_neg_integer()} | {buffer, non_neg_integer()} | <item> <title>ranch_tcp(3)</title> - <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_tcp/</link> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_tcp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_tcp/</guid> + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> +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.4/manual/ranch_transport/</link> + <title>ranch_tcp(3)</title> + <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_tcp/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/ranch/1.4/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.0/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> @@ -12395,6 +12990,19 @@ close close(Socket :: socket()) -&gt; ok Close the socket.</description> <item> <title>ranch_transport(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_transport/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_transport/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -12432,6 +13040,18 @@ This function emulates the function file:sendfile/2,4,5 and may be used when tra <item> <title>ranch_transport:sendfile(3)</title> + <link>https://ninenines.eu/docs/en/ranch/1.8/manual/ranch_transport.sendfile/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.8/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> + + <item> + <title>ranch_transport:sendfile(3)</title> <link>https://ninenines.eu/docs/en/ranch/2.0/manual/ranch_transport.sendfile/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |