SimTX API/Packets/ListStations

ListStations

Frame	ClientFrame, field 30
Member	list_stations
Direction	Client → server
Session	Control, moderation
Roles	ROLE_CONTROL, ROLE_MODERATION.
Permission	None on control sessions; moderation.manage on moderation sessions
Answered by	StationList (moderation: then StationImpactList)
Answers
Defined in	control.proto

ListStations asks for the list of stations on the server. The server answers with StationList. On a moderation session the list includes client addresses and is followed by StationImpactList.

Definition

message ListStations {
  int64 request_id = 1;
  bool include_sessions = 2;
}

Fields

#	Field	Type	Description
1	request_id	int64	Nonzero; echoed in the StationList.
2	include_sessions	bool	Ignored by current servers, which always list live sessions. Send true.

Rate limiting

ListStations is a heavy request. Poll it every few seconds at most; the per-address heavy budget is 4 per second, shared by all control connections from the address.

Example

Complete frames, including the varint length prefix.

list_stations (client to server, 8 bytes):

07        frame length 7
F2 01 04  list_stations (ListStations), 4 bytes
  08 05   request_id = 5
  10 01   include_sessions = true

See also

• StationList
• Station list