View Source Surrealix.Socket (surrealix v0.1.8)

Socket module to wrap the interactions with WebSockex process.

Summary

Functions

Show all currently registered live queries (SQL)

Main method to send requests in blocking fashion to SurrealDB

Reset running live queries status, used after reconnection

Switch for auth_ready boolean flag

Busy-wait until the on_auth callback is executed

Types

Link to this type

base_connection_opts()

View Source
@type base_connection_opts() :: Surrealix.Config.socket_opts()
@type on_start() :: {:ok, pid()} | {:error, term()}

Functions

Show all currently registered live queries (SQL)

Main method to send requests in blocking fashion to SurrealDB

Reset running live queries status, used after reconnection

Link to this function

set_auth_ready(pid, value)

View Source

Switch for auth_ready boolean flag

@spec start_link(Surrealix.Config.socket_opts()) :: on_start()
@spec stop(pid()) :: :ok
Link to this function

wait_until_auth_ready(pid)

View Source

Busy-wait until the on_auth callback is executed