SimTX API v24/Moderation session
A moderation session (role 5, MODERATION) gives SimTX moderators tools to see who is on a server and to remove disruptive stations. It is documented for completeness, so that the packet IDs in the packet list are all explained. Third-party software cannot use it without an account holding the moderation.manage permission, and the account service will not issue a moderation ticket otherwise.
Permissions within the session[edit | edit source]
The server checks two grants for each request:
- MODERATE, from
moderation.manage: listing stations with addresses, kicking, IP bans and banners. - MONITOR, from
monitor.any: monitoring any transmitter.
A request without the matching grant is answered with ModerationError and the session stays open.
Packets[edit | edit source]
| Request (C2S) | Response (S2C) | Grant | Purpose |
|---|---|---|---|
| ListStations (4) | StationList (9), then StationImpactList (18) | MODERATE | Stations including client addresses, followed by an interference analysis. |
| KickRequest (5) | KickResult (13) | MODERATE | Disconnect stations by callsign or UUID. |
| IpModerationRequest (9) | IpModerationResult (15) | MODERATE | Ban or unban an address. |
| BroadcastBanner (12) | None | MODERATE | Show, replace or clear the server notice. |
| StartMonitor (6), StopMonitor (7) | MonitorBlock (10), MonitorEnd (11) | MONITOR | Listen to any transmitter. |
Errors are reported with ModerationError (12).
Effects of a ban[edit | edit source]
When an address is banned, the server kicks its receiver and transmitter sessions. Its control sessions stay connected and receive a Banner of level 1 (ban notice) with the reason, so that the user's application can explain what happened. New game connections from the address are rejected with IP_BANNED.