phoenix_pubsub v2.0.0 Phoenix.Tracker.Shard behaviour View Source

Keeps track of presences in a single shard

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_by_key(server_pid, topic, key)

graceful_permdown(server_pid)

init(list)

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

list(server_pid, topic)

name_for_number(prefix, n)

name_for_topic(prefix, topic, pool_size)

start_link(tracker, tracker_opts, pool_opts)

track(server_pid, pid, topic, key, meta)

untrack(server_pid, pid)

untrack(server_pid, pid, topic, key)

update(server_pid, pid, topic, key, meta)

validate_down_period(d_period, b_period)

validate_permdown_period(p_period, d_period)

Link to this section Types

presence()

presence() :: {key :: String.t(), meta :: map()}

t()

t() :: %{
  shard_name: String.t(),
  pubsub_server: atom(),
  tracker: module(),
  tracker_state: any(),
  replica: Phoenix.Tracker.Replica.t(),
  report_events_to: any(),
  namespaced_topic: String.t(),
  log_level: boolean() | atom(),
  replicas: map(),
  pending_clockset: [],
  presences: Phoenix.Tracker.State.t(),
  broadcast_period: integer(),
  max_silent_periods: integer(),
  silent_periods: integer(),
  down_period: integer(),
  permdown_period: integer(),
  clock_sample_periods: integer(),
  deltas: [Phoenix.Tracker.State.delta()],
  max_delta_sizes: integer(),
  current_sample_count: integer()
}

topic()

topic() :: String.t()

Link to this section Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_by_key(server_pid, topic, key)

get_by_key(pid() | atom(), topic(), term()) :: [presence()]

graceful_permdown(server_pid)

graceful_permdown(pid()) :: :ok

init(list)

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 that it also sets a timeout. See the "Timeouts" section in the module documentation for more information.

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.