ZenWebsocket.HeartbeatManager (ZenWebsocket v0.4.2)

Copy Markdown View Source

Manages heartbeat lifecycle for WebSocket connections.

Pure functional module - state ownership stays with Client GenServer. Timer ownership stays with Client (Process.send_after needs self()).

API Functions

FunctionArityDescriptionParam Kinds
get_health1Return heartbeat health metrics.state: value
send_heartbeat1Send platform-specific heartbeat message.state: value
handle_message2Route incoming heartbeat message to platform-specific handler.msg: value, state: value
cancel_timer1Cancel active heartbeat timer. Call on disconnect/error.state: value
start_timer1Start heartbeat timer if configured. Call on connection upgrade.state: value

Summary

Types

health()

Health metrics returned by get_health/1

heartbeat_config()

Heartbeat configuration - disabled or platform-specific config map

state()

Client state map containing heartbeat fields (subset of Client.state)

Functions

cancel_timer(state)

Cancels active heartbeat timer. Call on disconnect/error.

get_health(state)

Returns heartbeat health metrics map.

handle_message(msg, state)

Routes incoming heartbeat messages to platform-specific handlers.

send_heartbeat(state)

Sends platform-specific heartbeat message.

start_timer(state)

Starts heartbeat timer if configured. Call on connection upgrade.

Types

health()

@type health() :: %{
  active_heartbeats: [term()],
  last_heartbeat_at: integer() | nil,
  failure_count: non_neg_integer(),
  config: heartbeat_config(),
  timer_active: boolean()
}

Health metrics returned by get_health/1

heartbeat_config()

@type heartbeat_config() :: :disabled | %{:type => atom(), optional(atom()) => term()}

Heartbeat configuration - disabled or platform-specific config map

state()

@type state() :: %{
  :heartbeat_config => heartbeat_config(),
  :heartbeat_timer => reference() | nil,
  :heartbeat_failures => non_neg_integer(),
  :active_heartbeats => MapSet.t(),
  optional(atom()) => term()
}

Client state map containing heartbeat fields (subset of Client.state)

Functions

cancel_timer(state)

@spec cancel_timer(state()) :: state()

Cancels active heartbeat timer. Call on disconnect/error.

Returns updated state with timer and failure count reset.

get_health(state)

@spec get_health(state()) :: health()

Returns heartbeat health metrics map.

handle_message(msg, state)

@spec handle_message(map(), state()) :: state()

Routes incoming heartbeat messages to platform-specific handlers.

Returns updated state after processing heartbeat.

send_heartbeat(state)

@spec send_heartbeat(state()) :: state()

Sends platform-specific heartbeat message.

Returns updated state with last_heartbeat_at timestamp for known types. Returns unchanged state for unrecognized or disabled configs.

start_timer(state)

@spec start_timer(state()) :: state()

Starts heartbeat timer if configured. Call on connection upgrade.

Returns updated state with timer reference.