Struct Sdk 

pub struct Sdk { /* private fields */ }

SDK is an instance of the Agones SDK

Implementations

impl Sdk

pub async fn connect( port: Option<u16>, connect_timeout: Option<Duration>, keep_alive: Option<Duration>, ) -> Result<(Self, GameServer)>

Starts a new SDK instance, and connects to localhost on the port specified or else falls back to the AGONES_SDK_GRPC_PORT environment variable, or defaults to 9357.

The connect_timeout applies to the time it takes to perform the initial connection as well as the handshake with the agones sidecar.

Errors

• The port specified in AGONES_SDK_GRPC_PORT can’t be parsed as a u16.
• A connection cannot be established with an Agones SDK server
• The handshake takes longer than the specified handshake_timeout duration

pub async fn mark_ready(&mut self) -> Result<()>

Marks the Game Server as ready to receive connections

pub async fn allocate(&mut self) -> Result<()>

Allocate the Game Server

pub async fn shutdown(&mut self) -> Result<()>

Marks the Game Server as ready to shutdown

pub fn health_check(&self) -> Sender<()>

Returns a tokio::sync::mpsc::Sender that will emit a health check every time a message is sent on the channel.

pub async fn set_label( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> Result<()>

Set a Label value on the backing Game Server record that is stored in Kubernetes

pub async fn set_annotation( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> Result<()>

Set an Annotation value on the backing Game Server record that is stored in Kubernetes

pub async fn get_gameserver(&mut self) -> Result<GameServer>

Returns most of the backing Game Server configuration and Status

pub async fn reserve(&mut self, duration: Duration) -> Result<()>

Reserve marks the Game Server as Reserved for a given duration, at which point it will return the Game Server to a Ready state.

Note that the smallest reserve duration is 1 second and is limited to second resolution.

pub async fn watch_gameserver( &mut self, ) -> Result<impl Stream<Item = Result<GameServer>>>

Watch the backing Game Server configuration on updated

Trait Implementations

impl Clone for Sdk

fn clone(&self) -> Sdk

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.