From 8459bebceb9533948193774371cbd9fd571b78ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 16 Oct 2019 09:48:31 +0200 Subject: Cowboy 2.7.0 --- .../2.8/manual/cow_cookie.parse_cookie/index.html | 180 +++++++++++++++++++ .../2.8/manual/cow_cookie.setcookie/index.html | 190 ++++++++++++++++++++ docs/en/cowlib/2.8/manual/cow_cookie/index.html | 195 +++++++++++++++++++++ docs/en/cowlib/2.8/manual/cowlib_app/index.html | 171 ++++++++++++++++++ docs/en/cowlib/2.8/manual/index.html | 171 ++++++++++++++++++ 5 files changed, 907 insertions(+) create mode 100644 docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html create mode 100644 docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html create mode 100644 docs/en/cowlib/2.8/manual/cow_cookie/index.html create mode 100644 docs/en/cowlib/2.8/manual/cowlib_app/index.html create mode 100644 docs/en/cowlib/2.8/manual/index.html (limited to 'docs/en/cowlib/2.8/manual') diff --git a/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html new file mode 100644 index 00000000..89a9720e --- /dev/null +++ b/docs/en/cowlib/2.8/manual/cow_cookie.parse_cookie/index.html @@ -0,0 +1,180 @@ + + + + + + + + + + Nine Nines: cow_cookie:parse_cookie(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cow_cookie:parse_cookie(3)

+ +

Name

+

cow_cookie:parse_cookie - Parse a cookie header

+

Description

+
+
parse_cookie(Cookie :: binary())
+    -> [{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

+
  • 1.0: Function introduced. +
    • +
+

Examples

+
Parse a cookie header
+
+
Cookies = cow_cookie:parse_cookie(CookieHd).
+
+

See also

+

cow_cookie(3), cow_cookie:setcookie(3)

+ + + + + + +
+ +
+ + +

+ Cowlib + 2.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 2.8
    • + +
+ +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + diff --git a/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html new file mode 100644 index 00000000..44d13859 --- /dev/null +++ b/docs/en/cowlib/2.8/manual/cow_cookie.setcookie/index.html @@ -0,0 +1,190 @@ + + + + + + + + + + Nine Nines: cow_cookie:setcookie(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cow_cookie:setcookie(3)

+ +

Name

+

cow_cookie:setcookie - Generate a set-cookie header

+

Description

+
+
setcookie(Name  :: iodata(),
+          Value :: iodata(),
+          Opts  :: cow_cookie:cookie_opts())
+    -> iolist()
+
+

Generate a set-cookie header.

+

Arguments

+
Name
+

Cookie name.

+
+
Value
+

Cookie value.

+
+
Opts
+

Options added to the set-cookie header as attributes.

+
+
+

Return value

+

An iolist with the generated set-cookie header value.

+

Changelog

+
  • 1.0: Function introduced. +
    • +
+

Examples

+
Generate a set-cookie header
+
+
SetCookie = cow_cookie:setcookie(<<"sessionid">>, ID, #{
+    http_only => true,
+    secure    => true
+}).
+
+

See also

+

cow_cookie(3), cow_cookie:parse_cookie(3)

+ + + + + + +
+ +
+ + +

+ Cowlib + 2.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 2.8
    • + +
+ +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + diff --git a/docs/en/cowlib/2.8/manual/cow_cookie/index.html b/docs/en/cowlib/2.8/manual/cow_cookie/index.html new file mode 100644 index 00000000..6b1f91fc --- /dev/null +++ b/docs/en/cowlib/2.8/manual/cow_cookie/index.html @@ -0,0 +1,195 @@ + + + + + + + + + + Nine Nines: cow_cookie(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cow_cookie(3)

+ +

Name

+

cow_cookie - Cookies

+

Description

+

The module cow_cookie provides functions for parsing and manipulating cookie headers.

+

Exports

+ +

Types

+

cookie_opts()

+
+
cookie_opts() :: #{
+    domain    => binary(),
+    http_only => boolean(),
+    max_age   => non_neg_integer(),
+    path      => binary(),
+    same_site => lax | strict,
+    secure    => boolean()
+}
+
+

Options for the set-cookie header. They are added to the header as attributes. More information about the options can be found in RFC 6265.

+

The following options are defined:

+
domain
+

Hosts to which the cookie will be sent. By default it will only be sent to the origin server.

+
+
http_only
+

Whether the cookie should be restricted to HTTP requests, or it should also be exposed to other APIs, for example Javascript. By default there are no restrictions.

+
+
max_age
+

Maximum lifetime of the cookie, in seconds. By default the cookie is kept for the duration of the session.

+
+
path
+

Path to which the cookie will be sent. By default it will be sent to the current "directory" of the effective request URI.

+
+
same_site
+

Whether the cookie should be sent along with cross-site requests. This header is currently non-standard but is in the process of being standardized. Please refer to the RFC 6265 (bis) draft for details.

+
+
secure
+

Whether the cookie should be sent only on secure channels (for example TLS). Note that this does not guarantee the integrity of the cookie, only its confidentiality during transfer. By default there are no restrictions.

+
+
+

See also

+

cowlib(7), RFC 6265

+ + + + + + +
+ +
+ + +

+ Cowlib + 2.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 2.8
    • + +
+ +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + diff --git a/docs/en/cowlib/2.8/manual/cowlib_app/index.html b/docs/en/cowlib/2.8/manual/cowlib_app/index.html new file mode 100644 index 00000000..1e0ad942 --- /dev/null +++ b/docs/en/cowlib/2.8/manual/cowlib_app/index.html @@ -0,0 +1,171 @@ + + + + + + + + + + Nine Nines: cowlib(7) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

cowlib(7)

+ +

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

+ +

Dependencies

+
  • crypto - Crypto functions +
    • +
+

All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:

+
+
{ok, _} = application:ensure_all_started(cowlib).
+
+

Environment

+

The cowlib application does not define any application environment configuration parameters.

+

See also

+

cowboy(7), gun(7)

+ + + + + + +
+ +
+ + +

+ Cowlib + 2.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 2.8
    • + +
+ +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + diff --git a/docs/en/cowlib/2.8/manual/index.html b/docs/en/cowlib/2.8/manual/index.html new file mode 100644 index 00000000..c10c8a8f --- /dev/null +++ b/docs/en/cowlib/2.8/manual/index.html @@ -0,0 +1,171 @@ + + + + + + + + + + Nine Nines: Cowlib Function Reference + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

Cowlib Function Reference

+ +

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

+ +

Dependencies

+
  • crypto - Crypto functions +
    • +
+

All these applications must be started before the cowlib application. To start Cowlib and all dependencies at once:

+
+
{ok, _} = application:ensure_all_started(cowlib).
+
+

Environment

+

The cowlib application does not define any application environment configuration parameters.

+

See also

+

cowboy(7), gun(7)

+ + + + + + +
+ +
+ + +

+ Cowlib + 2.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+
    + + + +
  • 2.8
    • + +
+ +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via BountySource. These funds are used to cover the recurring expenses like dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3