Grapher v0.9.1 Grapher.SchemaContext.Store View Source

Manages the storage of schema configurations

Link to this section Summary

Functions

Saves a new schema configuration with the given name. This function will return :context_already_configured if there is already a context registered with the given name

Returns a specification to start this module under a supervisor

Retrieves the context registered with the given name. If there is no context registered this function returns :no_such_context

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Updates the schema definition with the given name. This function will return :no_such_context if there is no context registered with the given name

Link to this section Functions

Link to this function add_context(name, context) View Source
add_context(Grapher.name(), Grapher.SchemaContext.t()) ::
  :ok | :context_already_configured

Saves a new schema configuration with the given name. This function will return :context_already_configured if there is already a context registered with the given name.

Parameters

  • name: An atom that will be used to reference this Schema Configuration
  • context: A Grapher.SchemaContext.t struct defining the Schema Configuration

Examples

iex> Store.add_context(:auth1, %SchemaContext{url: "www.com.com", headers: []})
:ok

iex> Store.add_context(:auth2, %SchemaContext{url: "www.com.com"})
iex> Store.add_context(:auth2, %SchemaContext{url: "www.net.com"})
:context_already_configured

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function get(name) View Source
get(Grapher.name()) :: Grapher.SchemaContext.t() | :no_such_context

Retrieves the context registered with the given name. If there is no context registered this function returns :no_such_context

Parameters

  • name: The registered name of the context to retrieve

Examples

iex> Store.get(:missing)
:no_such_context

iex> Store.add_context(:get, %SchemaContext{url: "com.com.com"})
iex> Store.get(:get)
%SchemaContext{url: "com.com.com", headers: []}

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 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 calling Supervisor.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.

Link to this function update_context(name, context) View Source
update_context(Grapher.name(), Grapher.SchemaContext.t()) ::
  :ok | :no_such_context

Updates the schema definition with the given name. This function will return :no_such_context if there is no context registered with the given name.

Parameters

  • name: An atom representing the name of the schema to be updated
  • context: A Grapher.SchemaContext.t struct defining the Schem Configuration that should replace the current configuration

Examples

iex> Store.add_context(:update, %SchemaContext{url: "www.org.com"})
iex> Store.update_context(:update, %SchemaContext{url: "www.com.com"})
:ok

iex> Store.update_context(:missing, %SchemaContext{url: "www.org.net"})
:no_such_context