Pow v1.0.1 Pow.Store.Backend.EtsCache View Source
GenServer based key value ETS cache store with auto expiration.
This module is not recommended for production, but mostly used as an example for how to build a cache. All data is stored in-memory, so cached values are not shared between machines.
Configuration options
:ttl
- integer value in milliseconds for ttl of records. If this value is not provided, or is set to nil, the records will never expire.:namespace
- string value to use for namespacing keys. Defaults to "cache".
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Callback implementation for Pow.Store.Base.delete/2
Callback implementation for Pow.Store.Base.get/2
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Callback implementation for Pow.Store.Base.keys/1
Callback implementation for Pow.Store.Base.put/3
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
delete(config, key)
View Source
delete(Pow.Config.t(), binary()) :: :ok
delete(Pow.Config.t(), binary()) :: :ok
Callback implementation for Pow.Store.Base.delete/2
.
get(config, key)
View Source
get(Pow.Config.t(), binary()) :: any() | :not_found
get(Pow.Config.t(), binary()) :: any() | :not_found
Callback implementation for Pow.Store.Base.get/2
.
init(config)
View Source
init(Pow.Config.t()) :: {:ok, map()}
init(Pow.Config.t()) :: {:ok, map()}
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
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
GenServer
is 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/2
after 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
.
keys(config)
View Source
keys(Pow.Config.t()) :: [any()]
keys(Pow.Config.t()) :: [any()]
Callback implementation for Pow.Store.Base.keys/1
.
put(config, key, value)
View Source
put(Pow.Config.t(), binary(), any()) :: :ok
put(Pow.Config.t(), binary(), any()) :: :ok
Callback implementation for Pow.Store.Base.put/3
.
start_link(config)
View Source
start_link(Pow.Config.t()) :: GenServer.on_start()
start_link(Pow.Config.t()) :: GenServer.on_start()