goth v1.2.0 Goth.TokenStore
The Goth.TokenStore
is a simple GenServer
that manages storage and retrieval
of tokens Goth.Token
. When adding to the token store, it also queues tokens
for a refresh before they expire: ten seconds before the token is set to expire,
the TokenStore
will call the API to get a new token and replace the expired
token in the store.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Retrieve a token from the TokenStore
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Store a token in the TokenStore
. Upon storage, Goth will queue the token
to be refreshed ten seconds before its expiration
Link to this section Functions
child_spec(init_arg)
Returns a specification to start this module under a supervisor.
See Supervisor
.
find(info, sub \\ nil)
Retrieve a token from the TokenStore
.
token = %Goth.Token{type: "Bearer",
token: "123",
scope: "scope",
expires: :os.system_time(:seconds) + 3600}
Goth.TokenStore.store(token)
{:ok, ^token} = Goth.TokenStore.find(token.scope)
init(state)
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
.
start_link()
store(token)
store(Goth.Token.t()) :: pid()
store(Goth.Token.t()) :: pid()
Store a token in the TokenStore
. Upon storage, Goth will queue the token
to be refreshed ten seconds before its expiration.
store(scopes, token)
store(scopes, sub, token)
store(String.t(), String.t(), Goth.Token.t()) :: pid()
store({String.t() | atom(), String.t()}, String.t() | nil, Goth.Token.t()) ::
pid()
store(String.t(), String.t(), Goth.Token.t()) :: pid()
store({String.t() | atom(), String.t()}, String.t() | nil, Goth.Token.t()) :: pid()