BaileysEx.Connection.Store (baileys_ex v0.1.0-alpha.8)

@type key() ::
  :auth_state
  | :blocklist
  | :connection_name
  | :creds
  | :last_prop_hash
  | :last_account_sync_timestamp
  | :privacy_settings
  | :props
  | {:app_state_sync_key, String.t()}
  | {:app_state_sync_version, atom()}
  | atom()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

delete(server, key)

@spec delete(GenServer.server() | BaileysEx.Connection.Store.Ref.t(), key()) :: :ok

Deletes a key from the connection store.

get(ref, key, default \\ nil)

@spec get(BaileysEx.Connection.Store.Ref.t(), key(), term()) :: term()

Reads a value from the connection store via an ETS ref immediately. Returns default if the key is not found or the ETS query fails.

get_app_state_sync_key(ref, key_id)

@spec get_app_state_sync_key(
  BaileysEx.Connection.Store.Ref.t() | GenServer.server(),
  String.t()
) ::
  {:ok, %{key_data: binary()}} | {:error, term()}

Fetch an app state sync key by its base64-encoded key ID.

Returns {:ok, %{key_data: binary()}} or {:error, {:key_not_found, key_id}}. Keys are stored under {:app_state_sync_key, key_id} in the ETS table.

get_app_state_sync_version(ref, collection_name)

@spec get_app_state_sync_version(
  BaileysEx.Connection.Store.Ref.t() | GenServer.server(),
  atom()
) ::
  map() | nil

Fetch the LTHash sync version state for a collection.

Returns nil if the collection has not been synced yet.

merge_creds(server, updates)

@spec merge_creds(GenServer.server() | BaileysEx.Connection.Store.Ref.t(), map()) ::
  :ok

Merges map updates into the connection's :auth_state, automatically computing and saving the :creds view projection simultaneously.

put(server, key, value)

@spec put(GenServer.server() | BaileysEx.Connection.Store.Ref.t(), key(), term()) ::
  :ok

Synchronously puts a key-value pair into the connection store.

put_app_state_sync_key(server_or_ref, key_id, key_data)

@spec put_app_state_sync_key(
  GenServer.server() | BaileysEx.Connection.Store.Ref.t(),
  String.t(),
  map()
) ::
  :ok

Store an app state sync key by its base64-encoded key ID.

put_app_state_sync_version(server_or_ref, collection_name, state)

@spec put_app_state_sync_version(
  GenServer.server() | BaileysEx.Connection.Store.Ref.t(),
  atom(),
  map() | nil
) :: :ok

Persist the LTHash sync version state for a collection.

snapshot(server)

@spec snapshot(GenServer.server() | BaileysEx.Connection.Store.Ref.t()) :: map()

Retrieves a deep map snapshot of the entire ETS connection store contents.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the GenServer that owns the connection ETS table.

wrap(server)

@spec wrap(GenServer.server()) :: BaileysEx.Connection.Store.Ref.t()

Returns a Ref struct allowing safe, concurrent reads from the ETS table owned by the Store server.