Appearance
WebSocketShard
Package: @erinjs/ws
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
options | WebSocketShardOptions | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
destroying | boolean | No | No | |
heartbeatAt | number | No | No | |
heartbeatInterval | number | null | No | No | |
id | number | Yes | No | |
lastHeartbeatAck | boolean | No | No | True until we send a heartbeat; then false until we get HeartbeatAck. Avoids closing before first heartbeat. |
options | WebSocketShardOptions | Yes | No | |
reconnectDelayMs | number | No | No | Current reconnect delay in ms; resets on successful connect. |
reconnectTimeout | number | null | No | No | |
seq | number | null | No | No | |
sessionId | string | null | No | No | |
status | number | Yes | No | |
url | string | Yes | No | |
ws | WebSocketLike | null | No | No | |
WS | WebSocketConstructor | Yes | No |
Methods
connect()
Returns: void
Parameters:
None
debug()
Returns: void
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
message | string | No |
destroy()
Returns: void
Parameters:
None
handleHello()
Returns: void
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
data | GatewayHelloData | No |
handlePayload()
Returns: void
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
payload | GatewayReceivePayload | No |
scheduleReconnect()
Returns: void
Parameters:
None
send()
Returns: void
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
payload | GatewaySendPayload | No |
startHeartbeat()
Returns: void
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
interval | number | No |
stopHeartbeat()
Returns: void
Parameters:
None