cookie_jar v1.0.4 CookieJar View Source
CookieJar is here to store your cookie
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Invoked when the server is started. start_link/3 or start/3 will
block until it returns
See what's in the cookie jar, the individual cookies
Pour cookies into a cookie jar
Put cookie into a cookie jar
Put new cookie into a cookie jar
Create a new cookie jar
Destroy a cookie jar
Get the cookies in Cookie format
Link to this section Functions
child_spec(arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor.
init(_) View Source
Invoked when the server is started. start_link/3 or start/3 will
block until it returns.
args is the argument term (second argument) passed to start_link/3.
Returning {:ok, state} will cause start_link/3 to return
{:ok, pid} and the process to enter its loop.
Returning {:ok, state, timeout} is similar to {:ok, state}
except handle_info(:timeout, state) will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate} is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3 for more information on hibernation.
Returning {:ok, state, {:continue, continue}} is similar to
{:ok, state} except that immediately after entering the loop
the c:handle_continue/2 callback will be invoked with the value
continue as first argument.
Returning :ignore will cause start_link/3 to return :ignore and
the process will exit normally without entering the loop or calling
c:terminate/2. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer. The remainder of the supervision tree will be started
and so the GenServer should not be required by other processes.
It can be started later with Supervisor.restart_child/2 as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServeris disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor. Likely this approach involves callingSupervisor.restart_child/2after a delay to attempt a restart.
Returning {:stop, reason} will cause start_link/3 to return
{:error, reason} and the process to exit with reason reason without
entering the loop or calling c:terminate/2.
Callback implementation for GenServer.init/1.
label(jar) View Source
new(opts \\ []) View Source
peek(jar)
View Source
peek(GenServer.server()) :: map()
peek(GenServer.server()) :: map()
See what's in the cookie jar, the individual cookies
Examples
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.peek(jar)
%{}
iex> CookieJar.put(jar, {"name", "john doe"})
iex> CookieJar.peek(jar)
%{"name" => "john doe"}
pour(jar, cookies)
View Source
pour(GenServer.server(), map()) :: :ok
pour(GenServer.server(), map()) :: :ok
Pour cookies into a cookie jar
Examples
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.peek(jar)
%{}
iex> CookieJar.pour(jar, %{"a" => 1, "b" => 2})
iex> CookieJar.peek(jar)
%{"a" => 1, "b" => 2}
put(jar, cookie)
View Source
put(GenServer.server(), {term(), term()}) :: :ok
put(GenServer.server(), {term(), term()}) :: :ok
Put cookie into a cookie jar
Examples
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.peek(jar)
%{}
iex> CookieJar.put(jar, {"a", 1})
iex> CookieJar.put(jar, {"b", 2})
iex> CookieJar.to_string(jar)
"a=1; b=2"
put_new(jar, cookie)
View Source
put_new(GenServer.server(), {term(), term()}) :: :ok
put_new(GenServer.server(), {term(), term()}) :: :ok
Put new cookie into a cookie jar
Examples
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.peek(jar)
%{}
iex> CookieJar.put(jar, {"a", 1})
iex> CookieJar.put_new(jar, {"a", 3})
iex> CookieJar.to_string(jar)
"a=1"
smash(jar) View Source
start_link(opts \\ [])
View Source
start_link(keyword()) :: GenServer.onstart()
start_link(keyword()) :: GenServer.onstart()
Create a new cookie jar
Examples
CookieJar.start_link
# or
CookieJar.new
stop(jar)
View Source
stop(GenServer.server()) :: :ok
stop(GenServer.server()) :: :ok
Destroy a cookie jar
Examples
CookieJar.stop(jar)
# or
CookieJar.smash(jar)
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.stop(jar)
iex> Process.alive?(jar)
false
to_string(jar)
View Source
to_string(GenServer.server()) :: String.t()
to_string(GenServer.server()) :: String.t()
Get the cookies in Cookie format
Examples
CookieJar.to_string(jar)
# or
CookieJar.label(jar)
iex> {:ok, jar} = CookieJar.new
iex> CookieJar.to_string(jar)
""
iex> CookieJar.put(jar, {"a", 1})
iex> CookieJar.put(jar, {"b", 2})
iex> CookieJar.to_string(jar)
"a=1; b=2"