Skip to content

GatewayHeartbeat

Defined in: packages/ws/src/heartbeat.ts:54

Heartbeat lifecycle for one Gateway connection.

new GatewayHeartbeat(options): GatewayHeartbeat

Defined in: packages/ws/src/heartbeat.ts:70

HeartbeatOptions

GatewayHeartbeat

get acknowledged(): boolean

Defined in: packages/ws/src/heartbeat.ts:90

Whether the most recent heartbeat has been acknowledged.

boolean


get interval(): number

Defined in: packages/ws/src/heartbeat.ts:85

Heartbeat interval Discord asked for, or 0 before HELLO.

number


get latency(): number

Defined in: packages/ws/src/heartbeat.ts:80

Round-trip time of the last acknowledged heartbeat, or -1 before the first.

number


get silentFor(): number

Defined in: packages/ws/src/heartbeat.ts:95

Milliseconds since the last inbound message, or 0 when none has arrived.

number


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.

number

acknowledge(): void

Defined in: packages/ws/src/heartbeat.ts:209

Records a heartbeat ACK and updates latency.

void


isHealthy(): boolean

Defined in: packages/ws/src/heartbeat.ts:115

Whether the connection looks alive: last beat acknowledged and traffic recent.

boolean


receivedMessage(): void

Defined in: packages/ws/src/heartbeat.ts:132

Records inbound traffic of any kind.

void


sendHeartbeat(): void

Defined in: packages/ws/src/heartbeat.ts:186

Sends a heartbeat now, and arms the acknowledgement deadline.

void


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.

number

void


stop(): void

Defined in: packages/ws/src/heartbeat.ts:179

Stops every timer. Safe to call more than once.

void


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.

void