game / pragma.gameinstance / GameInstanceService / gameKeepAliveV1 /

gameKeepAliveV1 #

suspend fun gameKeepAliveV1(session: PartnerSession, request: GameInstanceRpc.GameKeepAliveV1Request): GameInstanceRpc.GameKeepAliveV1Response

Invoked by the game server to indicate that a game instance is still operating normally.

Endpoint verifies that a game instance is still being tracked by the GameInstanceService and throws a PragmaError.GameInstanceService_UnknownGameInstanceId if this is not the case. This endpoint should only be used if GameInstanceServiceConfig.enableKeepAlive is enabled.

PragmaResultErrors

  • PragmaError.GameInstanceService_UnknownGameInstanceId - If the game instance id from the request is not found.
  • PragmaError.GameInstanceService_InternalError - If a lock on the specified game instance could not be held.