Skip to main content

ServerState

Lifecycle/capacity state of a game/GraphQL server in the fleet. Only ReadyForClients servers should receive new client connections; serverWithLeastClients and activeGraphQLServers already filter to healthy, non-overloaded servers.

enum ServerState {
  Starting
  ReadyForClients
  Stopping
  Offline
  NearCapacity
  Full
}

Values​

ServerState.Starting​

Booting / not yet ready: registered but still initializing; do not route client traffic here.

ServerState.ReadyForClients​

Healthy and accepting client traffic. The only state safe to route to.

ServerState.Stopping​

Draining / shutting down: finishing in-flight work; do not send new traffic.

ServerState.Offline​

Not running or unreachable (e.g. crashed or missed heartbeats).

ServerState.NearCapacity​

Buddy soft resource overload: excluded from new-client selection until it recovers; existing sessions continue.

ServerState.Full​

Buddy hard resource overload: excluded from new-client selection and actively shedding clients (sends reconnect commands so they migrate elsewhere).

Member Of​

GraphQLServer object ● ServerStatus object