Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit ad95e95

Browse files
committed
reorganize some categories
1 parent e71028f commit ad95e95

File tree

1 file changed

+18
-10
lines changed
  • docs/Protocol Specifications

1 file changed

+18
-10
lines changed

docs/Protocol Specifications/core.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ weight: 0
2828
- [3.2.1.2 Opcodes `op`](#3212-opcodes-op)
2929
- [3.2.1.3 Event names `t`](#3213-event-names-t)
3030
- [3.2.2 Heartbeats](#322-heartbeats)
31-
- [3.2.3 "Hello" event](#323-hello-event)
32-
- [3.2.4 Service channels](#324-service-channels)
33-
- [3.2.5 Identify](#325-identify)
34-
- [3.2.3 Events over REST](#323-events-over-rest)
31+
- [3.2.3 Event payload definitions](#323-event-payload-definitions)
32+
- [3.2.3.1 "Hello" event](#3231-hello-event)
33+
- [3.2.3.2 Identify](#3232-identify)
34+
- [3.2.3.3 Service channels](#3233-service-channels)
35+
- [3.2.3 Establishing a connection](#323-establishing-a-connection)
36+
- [3.2.4 Events over REST](#324-events-over-rest)
3537
- [3.3 HTTP](#33-http)
3638
- [3.4 Internet Protocol (IP)](#34-internet-protocol-ip)
3739
- [4. Federated identity](#4-federated-identity)
@@ -289,7 +291,9 @@ by sending a heartbeat event to the client.
289291

290292
The `d` payload for a heartbeat event is an empty object `{}`.
291293

292-
#### 3.2.3 "Hello" event
294+
#### 3.2.3 Event payload definitions
295+
296+
##### 3.2.3.1 "Hello" event
293297

294298
The "Hello" event is sent by the server to the client upon establishing a connection. The `d` payload
295299
for a "Hello" event is an object containing a `heartbeat_interval` field, which specifies the interval
@@ -307,7 +311,12 @@ in milliseconds at which the client should send heartbeat events to the server.
307311
| -------------------- | ------ | ---------------------------------------------------------------------------------------- |
308312
| `heartbeat_interval` | uint32 | Interval in milliseconds at which the client should send heartbeat events to the server. |
309313

310-
#### 3.2.4 Service channels
314+
##### 3.2.3.2 Identify
315+
316+
The "identify" event is sent by the client to the server to let the server know which actor the
317+
client is.
318+
319+
##### 3.2.3.3 Service channels
311320

312321
Service channels act like topics in a pub/sub system. They allow clients to subscribe to a specific
313322
topic and receive messages sent to that topic.
@@ -360,12 +369,11 @@ was successful or not.
360369
If a successful subscription to a service channel is acknowledged, all further events and logic
361370
is defined by the service's specification.
362371

363-
#### 3.2.5 Identify
372+
#### 3.2.3 Establishing a connection
364373

365-
The "identify" event is sent by the client to the server to let the server know which actor the
366-
client is.
374+
TODO
367375

368-
#### 3.2.3 Events over REST
376+
#### 3.2.4 Events over REST
369377

370378
For some implementation contexts, a constant WebSocket connection might not be wanted. A client can
371379
instead opt to query an API endpoint to receive events, which would normally be sent through the WebSocket

0 commit comments

Comments
 (0)