diff options
Diffstat (limited to 'docs/index.xml')
| -rw-r--r-- | docs/index.xml | 111 |
1 files changed, 107 insertions, 4 deletions
diff --git a/docs/index.xml b/docs/index.xml index 1cd6902c..4090aadc 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -3367,6 +3367,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.12/manual/cow_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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; default | none | strict | lax } 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> @@ -3415,6 +3426,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.12/manual/cow_cookie.cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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> @@ -3456,6 +3480,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.12/manual/cow_cookie.parse_cookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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> @@ -3510,6 +3548,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.12/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.12/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> @@ -3553,6 +3604,21 @@ 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.12/manual/cow_cookie.setcookie/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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 2.12: The Version attribute is no longer generated. 1.0: Function introduced. Examples Generate a set-cookie header SetCookie = cow_cookie:setcookie(&lt;&lt;"</description> + </item> + + <item> + <title>cow_cookie:setcookie(3)</title> <link>https://ninenines.eu/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/</link> <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> @@ -9032,6 +9098,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.12/manual/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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> @@ -9080,6 +9158,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.12/manual/cowlib_app/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/cowlib/2.12/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> @@ -9159,7 +9249,7 @@ Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support lib <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 gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events 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> +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols 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> @@ -9324,7 +9414,7 @@ Modules gun(3) - Asynchronous HTTP client Dependencies cowlib(7) - Support lib <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 gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events 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> +Modules gun(3) - Asynchronous HTTP client gun_cookies(3) - Cookie store engine gun_cookies_list(3) - Cookie store backend: in-memory, per connection gun_event(3) - Events gun_ws_protocol(3) - Websocket subprotocols 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> @@ -10610,7 +10700,7 @@ HTTP/1.1 cannot handle Websocket and HTTP requests concurrently. The upgrade, if <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 :: gun:stream_ref() 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 :: gun:stream_ref() 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> @@ -11326,6 +11416,19 @@ This message can only be sent on streams that were upgraded to the Websocket pro </item> <item> + <title>gun_ws_protocol(3)</title> + <link>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws_protocol/</link> + <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> + + <guid>https://ninenines.eu/docs/en/gun/2.0/manual/gun_ws_protocol/</guid> + <description>Name gun_ws_protocol - Websocket subprotocols +Description The gun_ws_protocol module provides the callback interface and types for implementing Websocket subprotocols. +Callbacks Websocket subprotocols implement the following interface. +init init(ReplyTo, StreamRef, Headers, Opts) -&gt; {ok, State} ReplyTo :: pid() StreamRef :: reference() Headers :: cow_http:headers() Opts :: gun:ws_opts() State :: protocol_state() Initialize the Websocket protocol. +ReplyTo The pid of the process that owns the stream and to which messages will be sent to.</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> @@ -13286,7 +13389,7 @@ Exports The module ranch_ssl implements the interface defined by ranch_transport 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()]} | {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()} | {certs_keys, [#{cert =&gt; public_key:der_encoded(), key =&gt; ssl:key(), certfile =&gt; file:filename(), keyfile =&gt; file:filename(), key_pem_password =&gt; iodata() | fun(() -&gt; iodata())}]} | {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> |