storex v0.2.0

View Source Storex.Registry behaviour (storex v0.2.0)

Link to this section Summary

Callbacks

get_store_pid(session, store)

Returns store PID by session id and store id.

register_session(session, pid)

Register session PID with a session id.

register_store(session, store, pid)

Register store PID in session by id with store id.

session_pid(session)

Gets session PID by session id.

session_stores(session)

Return list of stores registered with session id.

unregister_session(session)

Unregister session with a session id.

unregister_store(session, store)

Unegister store in session by id with store id.

Link to this section Callbacks

Link to this callback

get_store_pid(session, store)

View Source

Specs

get_store_pid(session :: String.t(), store :: String.t()) :: pid() | :undefined

Returns store PID by session id and store id.

Link to this callback

register_session(session, pid)

View Source

Specs

register_session(session :: String.t(), pid()) :: {:ok, pid()} | :error

Register session PID with a session id.

Link to this callback

register_store(session, store, pid)

View Source

Specs

register_store(session :: String.t(), store :: String.t(), pid()) ::
  {:ok, pid()} | :error

Register store PID in session by id with store id.

Link to this callback

session_pid(session)

View Source

Specs

session_pid(session :: String.t()) :: pid() | :undefined

Gets session PID by session id.

Link to this callback

session_stores(session)

View Source

Specs

session_stores(session :: String.t()) :: [String.t()]

Return list of stores registered with session id.

Link to this callback

unregister_session(session)

View Source

Specs

unregister_session(session :: String.t()) :: :ok | :error

Unregister session with a session id.

Link to this callback

unregister_store(session, store)

View Source

Specs

unregister_store(session :: String.t(), store :: String.t()) :: :ok | :error

Unegister store in session by id with store id.