GatewayHeartbeat
Defined in: packages/ws/src/heartbeat.ts:54
Heartbeat lifecycle for one Gateway connection.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GatewayHeartbeat(
options):GatewayHeartbeat
Defined in: packages/ws/src/heartbeat.ts:70
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”GatewayHeartbeat
Accessors
Section titled “Accessors”acknowledged
Section titled “acknowledged”Get Signature
Section titled “Get Signature”get acknowledged():
boolean
Defined in: packages/ws/src/heartbeat.ts:90
Whether the most recent heartbeat has been acknowledged.
Returns
Section titled “Returns”boolean
interval
Section titled “interval”Get Signature
Section titled “Get Signature”get interval():
number
Defined in: packages/ws/src/heartbeat.ts:85
Heartbeat interval Discord asked for, or 0 before HELLO.
Returns
Section titled “Returns”number
latency
Section titled “latency”Get Signature
Section titled “Get Signature”get latency():
number
Defined in: packages/ws/src/heartbeat.ts:80
Round-trip time of the last acknowledged heartbeat, or -1 before the first.
Returns
Section titled “Returns”number
silentFor
Section titled “silentFor”Get Signature
Section titled “Get Signature”get silentFor():
number
Defined in: packages/ws/src/heartbeat.ts:95
Milliseconds since the last inbound message, or 0 when none has arrived.
Returns
Section titled “Returns”number
stalenessDeadline
Section titled “stalenessDeadline”Get Signature
Section titled “Get Signature”get stalenessDeadline():
number
Defined in: packages/ws/src/heartbeat.ts:107
Deadline beyond which silence means the connection is dead.
At least one heartbeat interval plus its ACK budget, so a quiet Gateway is never mistaken for a dead one.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”acknowledge()
Section titled “acknowledge()”acknowledge():
void
Defined in: packages/ws/src/heartbeat.ts:209
Records a heartbeat ACK and updates latency.
Returns
Section titled “Returns”void
isHealthy()
Section titled “isHealthy()”isHealthy():
boolean
Defined in: packages/ws/src/heartbeat.ts:115
Whether the connection looks alive: last beat acknowledged and traffic recent.
Returns
Section titled “Returns”boolean
receivedMessage()
Section titled “receivedMessage()”receivedMessage():
void
Defined in: packages/ws/src/heartbeat.ts:132
Records inbound traffic of any kind.
Returns
Section titled “Returns”void
sendHeartbeat()
Section titled “sendHeartbeat()”sendHeartbeat():
void
Defined in: packages/ws/src/heartbeat.ts:186
Sends a heartbeat now, and arms the acknowledgement deadline.
Returns
Section titled “Returns”void
start()
Section titled “start()”start(
interval):void
Defined in: packages/ws/src/heartbeat.ts:144
Starts heartbeating at Discord’s interval.
The first beat is jittered across the interval, as Discord’s documentation requires, so a fleet reconnecting together does not heartbeat in lockstep.
Parameters
Section titled “Parameters”interval
Section titled “interval”number
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: packages/ws/src/heartbeat.ts:179
Stops every timer. Safe to call more than once.
Returns
Section titled “Returns”void
watch()
Section titled “watch()”watch():
void
Defined in: packages/ws/src/heartbeat.ts:125
Begins watching for silence. Call when the connection opens, before HELLO: a connection that never reaches HELLO must still be detected as dead.
Returns
Section titled “Returns”void