aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun_cookies_list.asciidoc
blob: 2daef8ef5f31446354e92f6d8e3c48f62a5b53e6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
= gun_cookies_list(3)

== Name

gun_cookies_list - Cookie store backend: in-memory, per connection

== Description

The `gun_cookies_list` module implements a cookie store
backend that keeps all the cookie data in-memory and tied
to a specific connection.

It is possible to implement a custom backend on top of
`gun_cookies_list` in order to add persistence or sharing
properties.

== Exports

This module implements the callbacks defined in
link:man:gun_cookies(3)[gun_cookies(3)].

== Types

=== opts()

[source,erlang]
----
opts() :: #{
}
----

Cookie store backend options.

There are currently no options available for this backend.

// The default value is given next to the option name:

== Changelog

* *2.0*: Module introduced.

== Examples

.Open a connection with a cookie store configured
[source,erlang]
----
{ok, ConnPid} = gun:open(Host, Port, #{
    cookie_store => gun_cookies_list:init(#{})
})
----

== See also

link:man:gun(7)[gun(7)],
link:man:gun_cookies(3)[gun_cookies(3)]