SimTX API v24/Packets/ListStations: Difference between revisions
m Clanker moved page SimTX API/Packets/ListStations to SimTX API v24/Packets/ListStations: Archive the v24 protocol reference |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = ListStations | | name = ListStations | ||
| id = 4 | | id = 4 | ||
| hex = 0x04 | | hex = 0x04 | ||
| direction = c2s | | direction = c2s | ||
| session = [[SimTX API/Control session|Control]] | | session = [[SimTX API v24/Control session|Control]] | ||
| size = 0 bytes | | size = 0 bytes | ||
| permission = None | | permission = None | ||
| reply = [[SimTX API/Packets/StationList|StationList]] | | reply = [[SimTX API v24/Packets/StationList|StationList]] | ||
| group = control | | group = control | ||
}} | }} | ||
'''ListStations''' asks for the list of stations currently on the server. The packet has no body. The server answers with [[SimTX API/Packets/StationList|StationList]]. On a [[SimTX API/Moderation session|moderation session]], it is also followed by [[SimTX API/Packets/StationImpactList|StationImpactList]]. | '''ListStations''' asks for the list of stations currently on the server. The packet has no body. The server answers with [[SimTX API v24/Packets/StationList|StationList]]. On a [[SimTX API v24/Moderation session|moderation session]], it is also followed by [[SimTX API v24/Packets/StationImpactList|StationImpactList]]. | ||
== Layout == | == Layout == | ||
| Line 23: | Line 23: | ||
ListStations is a heavy request. Poll it every few seconds at most; the per-IP heavy budget is 4 per second, shared by all control connections from the address, and exceeding it closes the connection. | ListStations is a heavy request. Poll it every few seconds at most; the per-IP heavy budget is 4 per second, shared by all control connections from the address, and exceeding it closes the connection. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:16, 24 October 2026
| Packet ID | 4(0x04)
|
|---|---|
| Direction | Client → server |
| Session | Control |
| Body size | 0 bytes |
| Permission | None |
| Answered by | StationList |
ListStations asks for the list of stations currently on the server. The packet has no body. The server answers with StationList. On a moderation session, it is also followed by StationImpactList.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 4.
|
Rate limiting[edit | edit source]
ListStations is a heavy request. Poll it every few seconds at most; the per-IP heavy budget is 4 per second, shared by all control connections from the address, and exceeding it closes the connection.