diff options
Diffstat (limited to 'index.xml')
| -rw-r--r-- | index.xml | 1151 |
1 files changed, 890 insertions, 261 deletions
@@ -6,7 +6,7 @@ <description>Recent content on Nine Nines</description> <generator>Hugo -- gohugo.io</generator> <language>en-us</language> - <lastBuildDate>Thu, 22 Aug 2019 07:00:00 +0100</lastBuildDate> + <lastBuildDate>Fri, 27 Sep 2019 07:00:00 +0100</lastBuildDate> <atom:link href="https://ninenines.eu/index.xml" rel="self" type="application/rss+xml" /> @@ -73,6 +73,20 @@ Copyright (c) 2013-2018, Loïc Hoguin &lt;[email protected]&gt; Permiss <item> <title>Introduction</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/introduction/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/introduction/</guid> + <description>Gun is an HTTP client for Erlang/OTP. +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. +Prerequisites Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 and Websocket protocols is required in order to read this guide. +Supported platforms Gun is tested and supported on Linux, FreeBSD, Windows and OSX. +Gun is developed for Erlang/OTP 20.0 and newer. +Note that Gun will not work on the Windows build of Erlang/OTP 20.3 due to a bug in Erlang/OTP&apos;s stdlib application.</description> + </item> + + <item> + <title>Introduction</title> <link>https://ninenines.eu/docs/en/ranch/1.4/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -339,6 +353,19 @@ Starting Gun in an Erlang shell 1&gt; application:ensure_all_started(gun).</ </item> <item> + <title>Starting and stopping</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/start/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/start/</guid> + <description>This chapter describes how to start and stop the Gun application. +Setting up Specify Gun as a dependency to your application in your favorite build tool. +With Erlang.mk this is done by adding gun to the DEPS variable in your Makefile. +Adding Gun as an Erlang.mk dependency DEPS = gun Starting Gun is an OTP application. It needs to be started before you can use it. +Starting Gun in an Erlang shell 1&gt; application:ensure_all_started(gun).</description> + </item> + + <item> <title>Supported protocols</title> <link>https://ninenines.eu/docs/en/gun/1.0/guide/protocols/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -387,6 +414,18 @@ Gun will send a gun_inform message for every intermediate informational response </item> <item> + <title>Supported protocols</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/protocols/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/protocols/</guid> + <description>This chapter describes the protocols supported and the operations available to them. +HTTP/1.1 HTTP/1.1 is a text request-response protocol. The client sends a request, the server sends back a response. +Gun provides convenience functions for performing GET, HEAD, OPTIONS, POST, PATCH, PUT, and DELETE requests. All these functions are aliases of gun:headers/4,5 or gun:request/5,6 for the respective methods. Gun also provides a gun:data/4 function for streaming the request body. +Gun will send a gun_inform message for every intermediate informational responses received.</description> + </item> + + <item> <title>Introduction</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/guide/introduction/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -556,6 +595,17 @@ A Gun connection is an Erlang process that manages a socket to a remote endpoint </item> <item> + <title>Connection</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/connect/</guid> + <description>This chapter describes how to open, monitor and close a connection using the Gun client. +Gun connections Gun is designed with the HTTP/2 and Websocket protocols in mind. They are built for long-running connections that allow concurrent exchange of data, either in the form of request/responses for HTTP/2 or in the form of messages for Websocket. +A Gun connection is an Erlang process that manages a socket to a remote endpoint.</description> + </item> + + <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> @@ -704,6 +754,18 @@ Streams can be canceled at any time.</description> </item> <item> + <title>HTTP</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/http/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/http/</guid> + <description>This chapter describes how to use the Gun client for communicating with an HTTP/1.1 or HTTP/2 server. +Streams Every time a request is initiated, Gun creates a stream. A stream reference uniquely identifies a set of request and response and must be used to perform additional operations with a stream or to identify its messages. +Stream references use the Erlang reference data type and are therefore unique. +Streams can be canceled at any time.</description> + </item> + + <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> @@ -858,6 +920,17 @@ You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</descrip </item> <item> + <title>Websocket</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/websocket/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/websocket/</guid> + <description>This chapter describes how to use the Gun client for communicating with a Websocket server. +HTTP upgrade Websocket is a protocol built on top of HTTP. To use Websocket, you must first request for the connection to be upgraded. Only HTTP/1.1 connections can be upgraded to Websocket, so you might need to restrict the protocol to HTTP/1.1 if you are planning to use Websocket over TLS. +You must use the gun:ws_upgrade/2,3,4 function to upgrade to Websocket.</description> + </item> + + <item> <title>Writing parsers</title> <link>https://ninenines.eu/docs/en/ranch/1.4/guide/parsers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -913,6 +986,17 @@ This chapter isn&apos;t specifically about Ranch, we assume here that you kn </item> <item> + <title>Changes since Gun 1.3</title> + <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.3/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.3/</guid> + <description>The following patch versions were released since Gun 1.3: +Gun 1.3.1 This release backports a fix that will be included in the upcoming Gun 2.0 release: +POTENTIAL SECURITY VULNERABILITY: Fix transfer-encoding precedence over content-length in responses. This bug may contribute to a response smuggling security vulnerability when Gun is used inside a proxy. </description> + </item> + + <item> <title>Migrating from Gun 1.0 to 1.1</title> <link>https://ninenines.eu/docs/en/gun/1.1/guide/migrating_from_1.0/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -933,13 +1017,14 @@ Features added CONNECT requests can now be issued on HTTP/1.1 connections. The t </item> <item> - <title>Migrating from Gun 1.2 to 1.3</title> - <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.2/</link> + <title>Migrating from Gun 1.3 to 2.0</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.3/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.2/</guid> - <description>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation. -Features added The protocols CONNECT destination option has been added as a replacement for the now deprecated protocol option. Add built-in support for Websocket protocol negotiation through the Websocket option protocols. The interface of the handler module currently remains undocumented and must be set to gun_ws_h. Add the h2specd HTTP/2 test suite from the h2spec project.</description> + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.3/</guid> + <description>Gun 2.0 adds many features including graceful shutdown, flow control for data messages, event handlers, support for tunneling TLS connections through TLS proxies, Socks proxy support, and much more. It has only a limited number of breaking changes compared to the previous version. +Gun 2.0 greatly improves the HTTP/2 performance when it comes to receiving large response bodies; and when receiving response bodies from many separate requests concurrently. +Gun now shares much of its HTTP/2 code with Cowboy, including the HTTP/2 state machine.</description> </item> <item> @@ -1168,13 +1253,23 @@ Features added Update Cowlib to 2.5.1 Bugs fixed A bug in the experimental gun </item> <item> - <title>Migrating from Gun 1.1 to 1.2</title> - <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</link> + <title>Migrating from Gun 1.2 to 1.3</title> + <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.2/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</guid> - <description>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections. -Features added CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies.</description> + <guid>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.2/</guid> + <description>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation. +Features added The protocols CONNECT destination option has been added as a replacement for the now deprecated protocol option. Add built-in support for Websocket protocol negotiation through the Websocket option protocols. The interface of the handler module currently remains undocumented and must be set to gun_ws_h. Add the h2specd HTTP/2 test suite from the h2spec project.</description> + </item> + + <item> + <title>Migrating from Gun 1.2 to 1.3</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.2/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.2/</guid> + <description>Gun 1.3 improves the support for CONNECT requests introduced in the previous version and documents Websocket protocol negotiation. +Features added The protocols CONNECT destination option has been added as a replacement for the now deprecated protocol option. Add built-in support for Websocket protocol negotiation through the Websocket option protocols. The interface of the handler module currently remains undocumented and must be set to gun_ws_h. Add the h2specd HTTP/2 test suite from the h2spec project.</description> </item> <item> @@ -1268,13 +1363,23 @@ Note that for everything related to efficiency and performance, you should perfo </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> + <title>Migrating from Gun 1.1 to 1.2</title> + <link>https://ninenines.eu/docs/en/gun/1.3/guide/migrating_from_1.1/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - <guid>https://ninenines.eu/docs/en/gun/1.3/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/gun/1.3/guide/migrating_from_1.1/</guid> + <description>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections. +Features added CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies.</description> + </item> + + <item> + <title>Migrating from Gun 1.1 to 1.2</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.1/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/migrating_from_1.1/</guid> + <description>Gun 1.2 adds support for the CONNECT request over HTTP/1.1 connections. +Features added CONNECT requests can now be issued on HTTP/1.1 connections. The tunneled connection can use any of the protocols Gun supports: HTTP/1.1, HTTP/2 and Websocket over both TCP and TLS transports. Note that Gun currently does not support tunneling a TLS connection over a TLS connection due to limitations in Erlang/OTP. Gun supports sending multiple CONNECT requests, allowing the tunnel to the origin server to go through multiple proxies.</description> </item> <item> @@ -1425,6 +1530,26 @@ Loop handlers are used for requests where a response might not be immediately av </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> + + <guid>https://ninenines.eu/docs/en/gun/1.3/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> + <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/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> <title>Static files</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/guide/static_files/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -2609,6 +2734,17 @@ HTTP IANA Registries HTTP Method Registry HTTP Status Code Registry Message He </item> <item> + <title>Gun 2.0 pre-release 1</title> + <link>https://ninenines.eu/articles/gun-2.0.0-pre.1/</link> + <pubDate>Fri, 27 Sep 2019 07:00:00 +0100</pubDate> + + <guid>https://ninenines.eu/articles/gun-2.0.0-pre.1/</guid> + <description>Gun 2.0.0-pre.1 has been released! +The first pre-release version of Gun 2.0 has been released! Gun 2.0 adds a ton of features along with a small number of breaking changes. +Before listing the features please note that this pre-release includes a fix for a potential security vulnerability! This only applies when Gun is used inside a proxy under specific circumstances. Please see the migration guide for details. Since the issue also exists in the previous version I have released Gun 1.</description> + </item> + + <item> <title>Erlang meetup: 10 septembre 2019</title> <link>https://ninenines.eu/articles/erlang-meetup-10-septembre-2019/</link> <pubDate>Thu, 22 Aug 2019 07:00:00 +0100</pubDate> @@ -3257,250 +3393,6 @@ cowboy(3) - Listener management cowboy_req(3) - Request and response cowboy_ro </item> <item> - <title>Gun Function Reference</title> - <link>https://ninenines.eu/docs/en/gun/1.0/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.0/manual/</guid> - <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP -Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. -Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> - </item> - - <item> - <title>Gun Function Reference</title> - <link>https://ninenines.eu/docs/en/gun/1.1/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.1/manual/</guid> - <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP -Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. -Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> - </item> - - <item> - <title>Gun Function Reference</title> - <link>https://ninenines.eu/docs/en/gun/1.2/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.2/manual/</guid> - <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP -Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. -Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> - </item> - - <item> - <title>Gun Function Reference</title> - <link>https://ninenines.eu/docs/en/gun/1.3/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.3/manual/</guid> - <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP -Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. -Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. -Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> - </item> - - <item> - <title>Gun User Guide</title> - <link>https://ninenines.eu/docs/en/gun/1.0/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.0/guide/</guid> - <description>Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket </description> - </item> - - <item> - <title>Gun User Guide</title> - <link>https://ninenines.eu/docs/en/gun/1.1/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.1/guide/</guid> - <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.0 to 1.1 </description> - </item> - - <item> - <title>Gun User Guide</title> - <link>https://ninenines.eu/docs/en/gun/1.2/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.2/guide/</guid> - <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </description> - </item> - - <item> - <title>Gun User Guide</title> - <link>https://ninenines.eu/docs/en/gun/1.3/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/gun/1.3/guide/</guid> - <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.2 to 1.3 Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </description> - </item> - - <item> - <title>HTTP status codes(7)</title> - <link>https://ninenines.eu/docs/en/cowboy/2.2/manual/http_status_codes/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.2/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.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> - - <guid>https://ninenines.eu/docs/en/cowboy/2.4/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.5/manual/http_status_codes/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.5/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.6/manual/http_status_codes/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/cowboy/2.6/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>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/manual/</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> - </item> - - <item> - <title>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/</guid> - <description>ranch(7) ranch(3) ranch_protocol(3) ranch_ssl(3) ranch_tcp(3) ranch_transport(3) </description> - </item> - - <item> - <title>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/</guid> - <description>Name ranch - Socket acceptor pool for TCP protocols -Description Ranch is a socket acceptor pool for TCP protocols. -Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. -Modules Functions: -ranch(3) - Socket acceptor pool Transports: -ranch_ssl(3) - SSL transport ranch_tcp(3) - TLS transport Behaviors:</description> - </item> - - <item> - <title>Ranch Function Reference</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/manual/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.7/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> - <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/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> - <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/1.4/guide/</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> - </item> - - <item> - <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/1.5/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.5/guide/</guid> - <description>Introduction Listeners Transports Protocols Embedded mode Writing parsers SSL client authentication Internals </description> - </item> - - <item> - <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/1.6/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/</guid> - <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Changes since Ranch 1.6 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> - </item> - - <item> - <title>Ranch User Guide</title> - <link>https://ninenines.eu/docs/en/ranch/1.7/guide/</link> - <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> - - <guid>https://ninenines.eu/docs/en/ranch/1.7/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 Changes since Ranch 1.7 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 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/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> <title>cowboy(3)</title> <link>https://ninenines.eu/docs/en/cowboy/2.2/manual/cowboy/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -4782,7 +4674,7 @@ Using the default configuration this function will always return undefined. You <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> +{ok, _} = cowboy:start_tls(example, [ {port, 8443}, {cert, "path/to/cert.pem"}, {verify, verify_peer} ], #{ env =&gt; #{dispatch =&gt; Dispatch} }).</description> </item> <item> @@ -7702,6 +7594,111 @@ init(Req, State) -&gt; {cowboy_websocket, Req, State} | {cowboy_websocket, R </item> <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/1.0/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.0/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/1.1/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.1/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/1.2/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.2/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/1.3/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.3/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> + <title>Gun Function Reference</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/1.0/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.0/guide/</guid> + <description>Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket </description> + </item> + + <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/1.1/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.1/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.0 to 1.1 </description> + </item> + + <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/1.2/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.2/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </description> + </item> + + <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/1.3/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/1.3/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Changes since Gun 1.3 Migrating from Gun 1.2 to 1.3 Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </description> + </item> + + <item> + <title>Gun User Guide</title> + <link>https://ninenines.eu/docs/en/gun/2.0/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/guide/</guid> + <description>Interface Introduction Starting and stopping Supported protocols Connection Using HTTP Using Websocket Additional information Migrating from Gun 1.3 to 2.0 Migrating from Gun 1.2 to 1.3 Migrating from Gun 1.1 to 1.2 Migrating from Gun 1.0 to 1.1 </description> + </item> + + <item> <title>gun(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7750,6 +7747,18 @@ gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - O </item> <item> + <title>gun(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun/</guid> + <description>Name gun - Asynchronous HTTP client +Description The gun module provides an asynchronous interface for connecting and communicating with Web servers over HTTP, HTTP/2 or Websocket. +Exports Connection: +gun:open(3) - Open a connection to the given host and port gun:open_unix(3) - Open a connection to the given Unix domain socket gun:set_owner(3) - Set a new owner for the connection gun:shutdown(3) - Gracefully close the connection gun:close(3) - Brutally close the connection gun:info(3) - Obtain information about the connection Requests:</description> + </item> + + <item> <title>gun(7)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_app/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7798,6 +7807,18 @@ Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support lib </item> <item> + <title>gun(7)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_app/</guid> + <description>Name gun - HTTP/1.1, HTTP/2 and Websocket client for Erlang/OTP +Description Gun is an HTTP client for Erlang/OTP with support for the HTTP/1.1, HTTP/2 and Websocket protocols. +Gun aims to provide an easy to use, asynchronous and always-connected client. It maintains a permanent connection to the server and reconnects automatically when necessary. +Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support library for manipulating Web protocols ssl - Secure communication over sockets All these applications must be started before the gun application.</description> + </item> + + <item> <title>gun:await(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7842,6 +7863,17 @@ This function waits for a message from the given stream and returns it as a tupl </item> <item> + <title>gun:await(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await/</guid> + <description>Name gun:await - Wait for a response +Description await(ConnPid, StreamRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, MonitorRef) -&gt; await(ConnPid, StreamRef, 5000, MonitorRef) await(ConnPid, StreamRef, Timeout) -&gt; await(ConnPid, StreamRef, Timeout, MonitorRef) await(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; Result ConnPid :: pid() StreamRef :: reference() MonitorRef :: reference() Timeout :: timeout() Result :: tuple() - see below Wait for a response. +This function waits for a message from the given stream and returns it as a tuple.</description> + </item> + + <item> <title>gun:await_body(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_body/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7882,6 +7914,16 @@ Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamR </item> <item> + <title>gun:await_body(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await_body/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await_body/</guid> + <description>Name gun:await_body - Wait for the complete response body +Description await_body(ConnPid, StreamRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, MonitorRef) -&gt; await_body(ConnPid, StreamRef, 5000, MonitorRef) await_body(ConnPid, StreamRef, Timeout) -&gt; await_body(ConnPid, StreamRef, Timeout, MonitorRef) await_body(ConnPid, StreamRef, Timeout, MonitorRef) -&gt; {ok, Body} | {ok, Body, Trailers} | {error, Reason} ConnPid :: pid() StreamRef :: reference() MonitorRef :: reference() Timeout :: timeout() Body :: binary() Trailers :: [{binary(), binary()}] Reason :: {stream_error | connection_error | down, any()} | timeout Wait for the complete response body.</description> + </item> + + <item> <title>gun:await_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.await_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7926,6 +7968,17 @@ Arguments ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun:await_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.await_up/</guid> + <description>Name gun:await_up - Wait for the connection to be up +Description await_up(ConnPid) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, MonitorRef) -&gt; await_up(ConnPid, 5000, MonitorRef) await_up(ConnPid, Timeout) -&gt; await_up(ConnPid, Timeout, MonitorRef) await_up(ConnPid, Timeout, MonitorRef) -&gt; {ok, Protocol} | {error, Reason} ConnPid :: pid() MonitorRef :: reference() Timeout :: timeout() Protocol :: http | http2 | socks Reason :: {down, any()} | timeout Wait for the connection to be up. +Arguments ConnPid The pid of the Gun connection process.</description> + </item> + + <item> <title>gun:cancel(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.cancel/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -7974,6 +8027,18 @@ HTTP/1.1 does not support this feature. Gun will simply silence the stream and s </item> <item> + <title>gun:cancel(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.cancel/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.cancel/</guid> + <description>Name gun:cancel - Cancel the given stream +Description cancel(ConnPid, StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: reference() Cancel the given stream. +The behavior of this function depends on the protocol selected. +HTTP/1.1 does not support this feature. Gun will simply silence the stream and stop relaying messages. Gun may also decide to close the connection if the response body is too large, to avoid wasting time and bandwidth.</description> + </item> + + <item> <title>gun:close(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.close/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8026,6 +8091,19 @@ Changelog 1.0: Function introduced. Examples Close the connection ok = gun:clo </item> <item> + <title>gun:close(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.close/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.close/</guid> + <description>Name gun:close - Brutally close the connection +Description close(ConnPid) -&gt; ok ConnPid :: pid() Brutally close the connection. +Arguments ConnPid The pid of the Gun connection process. + Return value The atom ok is returned. +Changelog 1.0: Function introduced. Examples Close the connection ok = gun:close(ConnPid). See also gun(3), gun:open(3), gun:open_unix(3), gun:shutdown(3)</description> + </item> + + <item> <title>gun:connect(3)</title> <link>https://ninenines.eu/docs/en/gun/1.2/manual/gun.connect/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8048,6 +8126,17 @@ This feature is currently only available for HTTP/1.1 connections. Upon successf </item> <item> + <title>gun:connect(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.connect/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.connect/</guid> + <description>Name gun:connect - Establish a tunnel to the origin server +Description connect(ConnPid, Destination) -&gt; connect(ConnPid, Destination, [], #{}). connect(ConnPid, Destination, Headers) -&gt; connect(ConnPid, Destination, Headers, #{}). connect(ConnPid, Destination, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Destination :: gun:connect_destination() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Establish a tunnel to the origin server. +This feature is currently only available for HTTP/1.1 connections. Upon successful completion of the CONNECT request a tunnel is established and subsequent requests will go through the tunnel.</description> + </item> + + <item> <title>gun:data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8096,6 +8185,18 @@ All calls to this function must use the nofin flag except for the last which mus </item> <item> + <title>gun:data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.data/</guid> + <description>Name gun:data - Stream the body of a request +Description data(ConnPid, StreamRef, IsFin, Data) -&gt; ok ConnPid :: pid() StreamRef :: reference() IsFin :: fin | nofin Data :: iodata() Stream the body of a request. +This function can only be used if the original request had headers indicating that a body would be streamed. +All calls to this function must use the nofin flag except for the last which must use fin to indicate the end of the request body.</description> + </item> + + <item> <title>gun:delete(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.delete/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8152,6 +8253,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:delete(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.delete/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.delete/</guid> + <description>Name gun:delete - Delete a resource +Description delete(ConnPid, Path) -&gt; delete(ConnPid, Path, [], #{}). delete(ConnPid, Path, Headers) -&gt; delete(ConnPid, Path, Headers, #{}) delete(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Delete a resource. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:flush(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.flush/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8208,6 +8323,20 @@ ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:flush(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.flush/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.flush/</guid> + <description>Name gun:flush - Flush all messages related to a connection or a stream +Description flush(ConnPid) -&gt; ok flush(StreamRef) -&gt; ok ConnPid :: pid() StreamRef :: reference() Flush all messages related to a connection or a stream. +Arguments Either of these arguments may be provided: +ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Return value The atom ok is returned.</description> + </item> + + <item> <title>gun:get(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.get/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8260,6 +8389,20 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:get(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.get/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.get/</guid> + <description>Name gun:get - Get a resource representation +Description get(ConnPid, Path) -&gt; get(ConnPid, Path, [], #{}). get(ConnPid, Path, Headers) -&gt; get(ConnPid, Path, Headers, #{}) get(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Get a resource representation. +Arguments ConnPid The pid of the Gun connection process. + Path Path to the resource. + Headers Additional request headers. + ReqOpts Request options.</description> + </item> + + <item> <title>gun:head(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.head/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8304,6 +8447,29 @@ This function performs the same operation as gun:get(3), except the server will </item> <item> + <title>gun:head(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.head/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.head/</guid> + <description>Name gun:head - Get headers of a resource representation +Description head(ConnPid, Path) -&gt; head(ConnPid, Path, [], #{}). head(ConnPid, Path, Headers) -&gt; head(ConnPid, Path, Headers, #{}) head(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Get headers of a resource representation. +This function performs the same operation as gun:get(3), except the server will not send the resource representation, only the response&apos;s status code and headers.</description> + </item> + + <item> + <title>gun:headers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.headers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.headers/</guid> + <description>Name gun:headers - Initiate the given request +Description headers(ConnPid, Method, Path, Headers) -&gt; headers(ConnPid, Method, Path, Headers, #{}) headers(ConnPid, Method, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Initiate the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply. +The function headers/4,5 initiates a request but does not send the request body.</description> + </item> + + <item> <title>gun:info(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.info/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8353,6 +8519,16 @@ Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ socket =&am </item> <item> + <title>gun:info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.info/</guid> + <description>Name gun:info - Obtain information about the connection +Description info(ConnPid) -&gt; Info ConnPid :: pid() Info :: #{ owner =&gt; pid(), socket =&gt; inet:socket() | ssl:sslsocket(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks | ws, sock_ip =&gt; inet:ip_address(), sock_port =&gt; inet:port_number(), origin_host =&gt; inet:hostname() | inet:ip_address(), origin_port =&gt; inet:port_number(), intermediaries =&gt; [Intermediary] } Intermediary :: #{ type =&gt; connect | socks5, host =&gt; inet:hostname() | inet:ip_address(), port =&gt; inet:port_number(), transport =&gt; tcp | tls, protocol =&gt; http | http2 | socks } Obtain information about the connection.</description> + </item> + + <item> <title>gun:open(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8405,6 +8581,17 @@ Arguments Host Host or IP address to connect to. </item> <item> + <title>gun:open(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.open/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.open/</guid> + <description>Name gun:open - Open a connection to the given host and port +Description open(Host, Port) -&gt; open(Host, Port, #{}) open(Host, Port, Opts) -&gt; {ok, pid()} | {error, Reason} Host :: inet:hostname() | inet:ip_address() Port :: inet:port_number() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given host and port. +Arguments Host Host or IP address to connect to.</description> + </item> + + <item> <title>gun:open_unix(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.open_unix/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8457,6 +8644,18 @@ Arguments SocketPath Path to the Unix domain socket to connect to. </item> <item> + <title>gun:open_unix(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.open_unix/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.open_unix/</guid> + <description>Name gun:open_unix - Open a connection to the given Unix domain socket +Description open_unix(SocketPath, Opts) -&gt; {ok, pid()} | {error, Reason} SocketPath :: string() Opts :: gun:opts() Reason :: {options, OptName} | {options, {http | http2 | socks | ws, OptName}} | any() OptName :: atom() Open a connection to the given Unix domain socket. +Arguments SocketPath Path to the Unix domain socket to connect to. + Opts Options for this connection.</description> + </item> + + <item> <title>gun:options(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.options/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8501,6 +8700,17 @@ The special path &quot;*&quot; can be used to obtain information about t </item> <item> + <title>gun:options(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.options/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.options/</guid> + <description>Name gun:options - Query the capabilities of the server or a resource +Description options(ConnPid, Path) -&gt; options(ConnPid, Path, [], #{}). options(ConnPid, Path, Headers) -&gt; options(ConnPid, Path, Headers, #{}) options(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() ReqOpts :: gun:req_opts() StreamRef :: reference() Query the capabilities of the server or a resource. +The special path &quot;*&quot; can be used to obtain information about the server as a whole.</description> + </item> + + <item> <title>gun:patch(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.patch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8545,6 +8755,16 @@ The behavior of this function varies depending on whether a body is provided.</d </item> <item> + <title>gun:patch(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.patch/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.patch/</guid> + <description>Name gun:patch - Apply a set of changes to a resource +Description patch(ConnPid, Path, Headers) -&gt; patch(ConnPid, Path, Headers, #{}) patch(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef patch(ConnPid, Path, Headers, Body) -&gt; patch(ConnPid, Path, Headers, Body, #{}) patch(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: reference() Apply a set of changes to a resource.</description> + </item> + + <item> <title>gun:post(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.post/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8589,6 +8809,16 @@ The behavior of this function varies depending on whether a body is provided.</d </item> <item> + <title>gun:post(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.post/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.post/</guid> + <description>Name gun:post - Process the enclosed representation according to a resource&apos;s own semantics +Description post(ConnPid, Path, Headers) -&gt; post(ConnPid, Path, Headers, #{}) post(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef post(ConnPid, Path, Headers, Body) -&gt; post(ConnPid, Path, Headers, Body, #{}) post(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: reference() Process the enclosed representation according to a resource&apos;s own semantics.</description> + </item> + + <item> <title>gun:put(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.put/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8637,6 +8867,17 @@ The function put/3 expects either a content-length or content-type header to ind </item> <item> + <title>gun:put(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.put/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.put/</guid> + <description>Name gun:put - Create or replace a resource +Description put(ConnPid, Path, Headers) -&gt; put(ConnPid, Path, Headers, #{}) put(ConnPid, Path, Headers, ReqOpts) -&gt; StreamRef put(ConnPid, Path, Headers, Body) -&gt; put(ConnPid, Path, Headers, Body, #{}) put(ConnPid, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: reference() Create or replace a resource. +The behavior of this function varies depending on whether a body is provided.</description> + </item> + + <item> <title>gun:request(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.request/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8681,6 +8922,70 @@ This is a general purpose function that should only be used when other method-sp </item> <item> + <title>gun:request(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.request/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.request/</guid> + <description>Name gun:request - Perform the given request +Description request(ConnPid, Method, Path, Headers, Body) -&gt; request(ConnPid, Method, Path, Headers, Body, #{}) request(ConnPid, Method, Path, Headers, Body, ReqOpts) -&gt; StreamRef ConnPid :: pid() Method :: binary() Path :: iodata() Headers :: gun:req_headers() Body :: iodata() ReqOpts :: gun:req_opts() StreamRef :: reference() Perform the given request. +This is a general purpose function that should only be used when other method-specific functions do not apply.</description> + </item> + + <item> + <title>gun:set_owner(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.set_owner/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.set_owner/</guid> + <description>Name gun:set_owner - Set a new owner for the connection +Description set_owner(ConnPid, OwnerPid) -&gt; ok ConnPid :: pid() OwnerPid :: pid() Set a new owner for the connection. +Only the current owner of the connection can set a new owner. +Gun monitors the owner of the connection and automatically shuts down gracefully when the owner exits. +Arguments ConnPid The pid of the Gun connection process. + OwnerPid The pid of the new owner for the connection.</description> + </item> + + <item> + <title>gun:shutdown(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.shutdown/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.shutdown/</guid> + <description>Name gun:shutdown - Gracefully close the connection +Description shutdown(ConnPid) -&gt; ok ConnPid :: pid() Gracefully close the connection. +Gun will wait for up to closing_timeout milliseconds before brutally closing the connection. The graceful shutdown mechanism varies between the different protocols: +For HTTP/1.1 there is no such mechanism and Gun will close the connection once the current response is received. Any pipelined requests are immediately terminated. For HTTP/2 Gun will send a GOAWAY frame and wait for the existing streams to terminate.</description> + </item> + + <item> + <title>gun:stream_info(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.stream_info/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.stream_info/</guid> + <description>Name gun:stream_info - Obtain information about a stream +Description stream_info(ConnPid, StreamRef) -&gt; {ok, undefined | Info} | {error, not_connected} ConnPid :: pid() StreamRef :: reference() Info :: #{ ref =&gt; reference(), reply_to =&gt; pid(), state =&gt; running | stopping } Obtain information about a stream. +Arguments ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Return value A map is returned containing various informations about the stream.</description> + </item> + + <item> + <title>gun:update_flow(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.update_flow/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.update_flow/</guid> + <description>Name gun:update_flow - Update a stream&apos;s flow control value +Description update_flow(ConnPid, StreamRef, Flow) -&gt; ok ConnPid :: pid() StreamRef :: reference() Flow :: pos_integer() Update a stream&apos;s flow control value. +The flow value can only ever be incremented. +This function does nothing for streams that have flow control disabled (which is the default). +Arguments ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request.</description> + </item> + + <item> <title>gun:ws_send(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_send/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8733,6 +9038,19 @@ Arguments ConnPid The pid of the Gun connection process. </item> <item> + <title>gun:ws_send(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.ws_send/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.ws_send/</guid> + <description>Name gun:ws_send - Send Websocket frames +Description ws_send(ConnPid, Frames) -&gt; ok ConnPid :: pid() Frames :: Frame | [Frame] Frame :: close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, non_neg_integer(), iodata()} Send Websocket frames. +The connection must first be upgraded to Websocket using the function gun:ws_upgrade(3). +Arguments ConnPid The pid of the Gun connection process. + Frames One or more Websocket frame(s).</description> + </item> + + <item> <title>gun:ws_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun.ws_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8781,6 +9099,18 @@ HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if </item> <item> + <title>gun:ws_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun.ws_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun.ws_upgrade/</guid> + <description>Name gun:ws_upgrade - Upgrade to Websocket +Description ws_upgrade(ConnPid, Path) -&gt; ws_upgrade(ConnPid, Path, []) ws_upgrade(ConnPid, Path, Headers) -&gt; StreamRef ws_upgrade(ConnPid, Path, Headers, WsOpts) -&gt; StreamRef ConnPid :: pid() Path :: iodata() Headers :: gun:req_headers() WsOpts :: gun:ws_opts StreamRef :: reference() Upgrade to Websocket. +The behavior of this function depends on the protocol selected. +HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if successful, will result in the complete takeover of the connection.</description> + </item> + + <item> <title>gun_data(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_data/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8833,6 +9163,19 @@ The response body may be terminated either by a data message with the flag fin s </item> <item> + <title>gun_data(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_data/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_data/</guid> + <description>Name gun_data - Response body +Description {gun_data, ConnPid, StreamRef, IsFin, Data} ConnPid :: pid() StreamRef :: reference() IsFin :: fin | nofin Data :: binary() Response body. +This message informs the relevant process that the server sent a all or part of the body for the response to the original request. +A data message is always preceded by a response message. +The response body may be terminated either by a data message with the flag fin set or by a gun_trailers(3) message.</description> + </item> + + <item> <title>gun_down(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_down/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8881,6 +9224,18 @@ When the connection goes back up, Gun will not attempt to retry requests.</descr </item> <item> + <title>gun_down(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_down/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_down/</guid> + <description>Name gun_down - The connection is down +Description {gun_down, ConnPid, Protocol, Reason, KilledStreams} ConnPid :: pid() Protocol :: http | http2 | socks | ws Reason :: any() KilledStreams :: [reference()] The connection is down. +This message informs the owner process that the connection was lost. Depending on the retry and retry_timeout options Gun may automatically attempt to reconnect. +When the connection goes back up, Gun will not attempt to retry requests.</description> + </item> + + <item> <title>gun_error(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_error/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8925,6 +9280,17 @@ These messages inform the relevant process that an error occurred. A reference i </item> <item> + <title>gun_error(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_error/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_error/</guid> + <description>Name gun_error - Stream or connection-wide error +Description {gun_error, ConnPid, StreamRef, Reason} {gun_error, ConnPid, Reason} ConnPid :: pid() StreamRef :: reference() Reason :: any() Stream or connection-wide error. +These messages inform the relevant process that an error occurred. A reference is given when the error pertains to a specific stream. Connection-wide errors do not imply that the connection is no longer usable, they are used for all errors that are not specific to a stream.</description> + </item> + + <item> <title>gun_inform(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_inform/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -8973,6 +9339,18 @@ Informational responses are only intermediate responses and provide no guarantee </item> <item> + <title>gun_inform(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_inform/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_inform/</guid> + <description>Name gun_inform - Informational response +Description {gun_inform, ConnPid, StreamRef, Status, Headers} ConnPid :: pid() StreamRef :: reference() Status :: 100..199 Headers :: [{binary(), binary()}] Informational response. +This message informs the relevant process that the server sent an informational response to the original request. +Informational responses are only intermediate responses and provide no guarantees as to what the final response will be. An informational response always precedes the response to the original request.</description> + </item> + + <item> <title>gun_push(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_push/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9021,6 +9399,18 @@ A server-initiated push message always precedes the response to the original req </item> <item> + <title>gun_push(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_push/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_push/</guid> + <description>Name gun_push - Server-initiated push +Description {gun_push, ConnPid, StreamRef, NewStreamRef, Method, URI, Headers} ConnPid :: pid() StreamRef :: reference() NewStreamRef :: reference() Method :: binary() URI :: binary() Headers :: [{binary(), binary()}] Server-initiated push. +This message informs the relevant process that the server is pushing a resource related to the effective target URI of the original request. +A server-initiated push message always precedes the response to the original request.</description> + </item> + + <item> <title>gun_response(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_response/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9077,6 +9467,33 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_response(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_response/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_response/</guid> + <description>Name gun_response - Response +Description {gun_response, ConnPid, StreamRef, IsFin, Status, Headers} ConnPid :: pid() StreamRef :: reference() IsFin :: fin | nofin Status :: non_neg_integer() Headers :: [{binary(), binary()}] Response. +This message informs the relevant process that the server sent a response to the original request. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + IsFin Whether this message terminates the response.</description> + </item> + + <item> + <title>gun_socks_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_socks_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_socks_up/</guid> + <description>Name gun_socks_up - The Socks connection is up +Description {gun_socks_up, ConnPid, Protocol} ConnPid :: pid() Protocol :: http | http2 | socks The Socks connection is up. +This message informs the owner/calling process that the connection completed through the configured Socks proxy. +If Gun is configured to connect to another Socks server, then the connection is not usable yet. One or more gun_socks_up(3) messages will follow. +Otherwise, Gun will start processing the messages it received while waiting for the connection to be up.</description> + </item> + + <item> <title>gun_trailers(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_trailers/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9137,6 +9554,21 @@ Elements ConnPid The pid of the Gun connection process. </item> <item> + <title>gun_trailers(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_trailers/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_trailers/</guid> + <description>Name gun_trailers - Response trailers +Description {gun_trailers, ConnPid, StreamRef, Headers} ConnPid :: pid() StreamRef :: reference() Headers :: [{binary(), binary()}] Response trailers. +This message informs the relevant process that the server sent response trailers for the response to the original request. +A trailers message terminates the response. +Elements ConnPid The pid of the Gun connection process. + StreamRef Identifier of the stream for the original request. + Headers Trailing headers sent after the response body.</description> + </item> + + <item> <title>gun_up(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_up/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9185,6 +9617,19 @@ Gun will now start processing the messages it received while waiting for the con </item> <item> + <title>gun_up(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_up/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <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. +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_socks_up(3) messages will follow. +Otherwise, Gun will start processing the messages it received while waiting for the connection to be up.</description> + </item> + + <item> <title>gun_upgrade(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_upgrade/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9233,6 +9678,18 @@ The exact semantics of this message depend on the original protocol. HTTP/1.1 up </item> <item> + <title>gun_upgrade(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_upgrade/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_upgrade/</guid> + <description>Name gun_upgrade - Successful protocol upgrade +Description {gun_upgrade, ConnPid, StreamRef, Protocols, Headers} ConnPid :: pid() StreamRef :: reference() Protocols :: [&lt;&lt;"websocket"&gt;&gt;] Headers :: [{binary(), binary()}] Successful protocol upgrade. +This message informs the relevant process that the server accepted to upgrade to one or more protocols given in the original request. +The exact semantics of this message depend on the original protocol. HTTP/1.1 upgrades apply to the entire connection. HTTP/2 uses a different mechanism which allows switching specific streams to a different protocol.</description> + </item> + + <item> <title>gun_ws(3)</title> <link>https://ninenines.eu/docs/en/gun/1.0/manual/gun_ws/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9285,6 +9742,178 @@ Elements ConnPid The pid of the Gun connection process.</description> </item> <item> + <title>gun_ws(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws/</guid> + <description>Name gun_ws - Websocket frame +Description {gun_ws, ConnPid, StreamRef, Frame} ConnPid :: pid() StreamRef :: reference() Frame :: close | ping | pong | {text | binary | close, binary()} | {close, non_neg_integer(), binary()} | {ping | pong, binary()} Websocket frame. +This message informs the relevant process that the server sent the enclosed frame. +This message can only be sent on streams that were upgraded to the Websocket protocol.</description> + </item> + + <item> + <title>HTTP status codes(7)</title> + <link>https://ninenines.eu/docs/en/cowboy/2.2/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.2/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.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> + + <guid>https://ninenines.eu/docs/en/cowboy/2.4/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.5/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.5/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.6/manual/http_status_codes/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowboy/2.6/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>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/1.4/manual/</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> + </item> + + <item> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/1.5/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.5/manual/</guid> + <description>ranch(7) ranch(3) ranch_protocol(3) ranch_ssl(3) ranch_tcp(3) ranch_transport(3) </description> + </item> + + <item> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/1.6/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.6/manual/</guid> + <description>Name ranch - Socket acceptor pool for TCP protocols +Description Ranch is a socket acceptor pool for TCP protocols. +Ranch manages listeners which are a set of processes that accept and manage connections. The connection&apos;s transport and protocol modules are configured per listener. Listeners can be inspected and reconfigured without interruptions in service. +Modules Functions: +ranch(3) - Socket acceptor pool Transports: +ranch_ssl(3) - SSL transport ranch_tcp(3) - TLS transport Behaviors:</description> + </item> + + <item> + <title>Ranch Function Reference</title> + <link>https://ninenines.eu/docs/en/ranch/1.7/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.7/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> + <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/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> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/1.4/guide/</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> + </item> + + <item> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/1.5/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.5/guide/</guid> + <description>Introduction Listeners Transports Protocols Embedded mode Writing parsers SSL client authentication Internals </description> + </item> + + <item> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/1.6/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/</guid> + <description>Interface Introduction Listeners Transports Protocols Embedded mode How to Writing parsers SSL client authentication Advanced Internals Additional information Upcoming changes in Ranch 2.0 Changes since Ranch 1.6 Migrating from Ranch 1.5 to 1.6 Migrating from Ranch 1.x </description> + </item> + + <item> + <title>Ranch User Guide</title> + <link>https://ninenines.eu/docs/en/ranch/1.7/guide/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/ranch/1.7/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 Changes since Ranch 1.7 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 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/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> <title>ranch(3)</title> <link>https://ninenines.eu/docs/en/ranch/1.4/manual/ranch/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |