Skip to content

Commit 4e5200e

Browse files
committed
docs: add AGENTS.md for realtime module
1 parent 8179a85 commit 4e5200e

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/lib/realtime/AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Realtime Socket Interface (src/lib/realtime/)
2+
3+
What lives here
4+
- `RealtimeController.ts`: Manages the Socket.IO server and client connections.
5+
- `RealtimeClient.ts`: Handles individual client socket sessions, authentication, and event processing.
6+
7+
Notes
8+
- This module implements the Realtime API documented in `docs/REALTIME_API.md`.
9+
- **CRITICAL:** If you modify the events, payloads, or authentication flow in this directory, you **MUST** update `docs/REALTIME_API.md` to reflect these changes.
10+
- The `playing` event updates are buffered in `RealtimeClient` and saved to the database every 10 seconds via `saveAllTracks`.

0 commit comments

Comments
 (0)