SimTX API/Packets/ServerHealthRequest
| Frame | ClientFrame, field 34
|
|---|---|
| Member | health
|
| Direction | Client → server |
| Session | Control |
| Roles | ROLE_CONTROL.
|
| Permission | None |
| Answered by | ServerHealthReport |
| Defined in | control.proto
|
ServerHealthRequest asks for a ServerHealthReport. It is a heavy request; status pages should poll it no more often than every few seconds.
Definition[edit | edit source]
message ServerHealthRequest { int64 request_id = 1; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
Nonzero; echoed in the ServerHealthReport. |