EDA.Gateway.Heartbeat (EDA v0.3.0)

Manages heartbeat timing for the Gateway connection.

Discord requires regular heartbeats to keep the connection alive. The interval is provided by Discord in the HELLO payload.

Summary

cancel(ref)

Cancels a pending heartbeat timer.

start(interval)

Schedules the next heartbeat at a fixed interval.

Schedules the first heartbeat after HELLO.

@spec cancel(reference() | nil) :: :ok

Cancels a pending heartbeat timer.

@spec start(integer()) :: reference()

Schedules the next heartbeat at a fixed interval.

@spec start_first(integer()) :: reference()

Schedules the first heartbeat after HELLO.

Per Discord docs, the first heartbeat should be sent after interval * jitter where jitter is between 0 and 1.