ReVanced/revanced-bots
1
0
Fork 0
mirror of https://github.com/ReVanced/revanced-bots.git synced 2026-01-23 19:21:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(apis/websocket): update docs

Browse Source
This commit is contained in:
PalmDevs
2024-01-14 21:39:05 +07:00
parent e9638a7713
commit 05176fbf26
6 changed files with 251 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
apis/websocket/docs/3_packets.md
View File

@@ -1,33 +1,33 @@
# 📨 Packets
Packets are BSON messages sent to the server. They're structured like the following when decoded:
```json
{
"op": 12345,
"d": {
"some_field": "some data"
}
}
```
### `packet.op`
Operation codes are numbers that communicate an action.
### `packet.d`
Data fields include additional information for the server to process. They are **either an object with specific fields or just `null`**.
#### 📦 Schemas and constants
Schemas for packets and their respective data[^1], and the list of possible operation codes[^2] can be found in the `@revanced/bot-shared` package, with typings as well.
[^1]: [`@revanced/bot-shared/src/schemas/Packet.ts`](../../packages/shared/src/schemas/Packet.ts)
[^2]: [`@revanced/bot-shared/src/constants/Operation`](../../packages/shared/src/constants/Operation.ts)
## 💓 Heartbeating
Heartbeating is a process where the client regularly send each other signals to confirm that they are still connected and functioning. If the server doesn't receive a heartbeat from the client within a specified timeframe, it assume the client has disconnected and closes the socket.
You can configure the interval in the configuration file. See [**📝 Configuration > `config.clientHeartbeatInterval`**](./1_configuration.md#configclientheartbeatinterval).
# 📨 Packets
Packets are BSON messages sent to the server. They're structured like the following when decoded:
```json
{
"op": 12345,
"d": {
"some_field": "some data"
}
}
```
### `packet.op`
Operation codes are numbers that communicate an action.
### `packet.d`
Data fields include additional information for the server to process. They are **either an object with specific fields or just `null`**.
#### 📦 Schemas and constants
Schemas for packets and their respective data[^1], and the list of possible operation codes[^2] can be found in the `@revanced/bot-shared` package, with typings as well.
[^1]: [`@revanced/bot-shared/src/schemas/Packet.ts`](../../packages/shared/src/schemas/Packet.ts)
[^2]: [`@revanced/bot-shared/src/constants/Operation`](../../packages/shared/src/constants/Operation.ts)
## 💓 Heartbeating
Heartbeating is a process where the client regularly send each other signals to confirm that they are still connected and functioning. If the server doesn't receive a heartbeat from the client within a specified timeframe, it assume the client has disconnected and closes the socket.
You can configure the interval in the configuration file. See [**📝 Configuration > `config.clientHeartbeatInterval`**](./1_configuration.md#configclientheartbeatinterval).