phoenix_pubsub v1.1.1 Phoenix.Tracker.Shard behaviour View Source

Keeps track of presences in a single shard

Link to this section Summary

Link to this section Types

Link to this type presence() View Source
presence() :: {key :: String.t(), meta :: map()}
Link to this type t() View Source
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()
}

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function get_by_key(server_pid, topic, key) View Source
get_by_key(pid() | atom(), topic(), term()) :: [presence()]
Link to this function graceful_permdown(server_pid) View Source
graceful_permdown(pid()) :: :ok

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 list(server_pid, topic) View Source
list(pid() | atom(), topic()) :: [presence()]
Link to this function name_for_number(prefix, n) View Source
name_for_number(atom(), non_neg_integer()) :: atom()
Link to this function name_for_topic(prefix, topic, pool_size) View Source
name_for_topic(atom(), topic(), non_neg_integer()) :: atom()
Link to this function start_link(tracker, tracker_opts, pool_opts) View Source
Link to this function track(server_pid, pid, topic, key, meta) View Source
track(pid(), pid(), topic(), term(), map()) ::
  {:ok, ref :: binary()} | {:error, reason :: term()}
Link to this function untrack(server_pid, pid) View Source
Link to this function untrack(server_pid, pid, topic, key) View Source
untrack(pid(), pid(), topic(), term()) :: :ok
Link to this function update(server_pid, pid, topic, key, meta) View Source
update(pid(), pid(), topic(), term(), map() | (map() -> map())) ::
  {:ok, ref :: binary()} | {:error, reason :: term()}
Link to this function validate_down_period(d_period, b_period) View Source
Link to this function validate_permdown_period(p_period, d_period) View Source

Link to this section Callbacks

Link to this callback handle_diff(%{}, state) View Source
handle_diff(
  %{optional(topic()) => {joins :: [presence()], leaves :: [presence()]}},
  state :: term()
) :: {:ok, state :: term()}
Link to this callback init(arg0) View Source
init(Keyword.t()) :: {:ok, pid()} | {:error, reason :: term()}