five-on-it / packages/protocol/src/platform / FleetHeartbeat

Variable: FleetHeartbeat

const FleetHeartbeat: ZodObject<{ capacity: ZodNumber; draining: ZodBoolean; id: ZodString; internalUrl: ZodURL; maxRooms: ZodOptional<ZodNumber>; maxRuns: ZodOptional<ZodNumber>; players: ZodNumber; protocolVersion: ZodNumber; publicUrl: ZodURL; rooms: ZodArray<ZodObject<{ frozen: ZodOptional<ZodBoolean>; game: ZodNullable<ZodString>; gone: ZodOptional<ZodArray<ZodString>>; id: ZodString; late: ZodOptional<ZodArray<ZodString>>; level: ZodString; maxPlayers: ZodNumber; open: ZodOptional<ZodArray<ZodObject<{ players: ZodNumber; seats: ZodNumber; team: ZodString; }, $strip>>>; players: ZodNumber; run: ZodOptional<ZodString>; title: ZodString; }, $strip>>; runs: ZodOptional<ZodNumber>; stepP95Ms: ZodNumber; version: ZodString; }, $strip>

Defined in: packages/protocol/src/platform.ts:301

A game server's heartbeat to the platform's fleet registry (every few seconds, with the fleet's secret): who it is, where players reach it (publicUrl, a WebSocket base) and where the API does (internalUrl, on the private network), its version, how full and how busy it is, the rooms it takes at most (maxRooms, when it was given a cap), the runs it plays at once at most (maxRuns) and those open and on their way (runs), its rooms, and whether it is draining (no new rooms: it restarts soon).