Skip to content

Commit

Permalink
Document SDK - Allocated->Ready() (#886)
Browse files Browse the repository at this point in the history
This has come up a fair bit lately, so good to document
that this is a supported and tested path.
  • Loading branch information
markmandel authored Jul 10, 2019
1 parent 715eefd commit e6f6153
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions site/content/en/docs/Guides/Client SDKs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Once a Game Server has specified that it is `Ready`, then the Kubernetes
GameServer record will be moved to the `Ready` state, and the details
for its public address and connection port will be populated.

While Agones prefers that `Shutdown()` is run once a game has completed to delete the `GameServer` instance,
if you want or need to move an `Allocated` `GameServer` back to `Ready` to be reused, you can call this SDK method again to do
this.

### Health()
This sends a single ping to designate that the Game Server is alive and
healthy. Failure to send pings within the configured thresholds will result
Expand Down

0 comments on commit e6f6153

Please sign in to comment.