sdk

Documentation

Overview

Package sdk is the Go game server sdk

Index

• type SDK
  • func NewSDK() (*SDK, error)
  • func (s *SDK) GameServer() (*sdk.GameServer, error)
  • func (s *SDK) Health() error
  • func (s *SDK) Ready() error
  • func (s *SDK) Shutdown() error

Types

type SDK

type SDK struct {
	// contains filtered or unexported fields
}

SDK is an instance of the Agones SDK

func NewSDK

func NewSDK() (*SDK, error)

NewSDK starts a new SDK instance, and connects to localhost on port 59357. Blocks until connection and handshake are made. Times out after 30 seconds.

func (*SDK) GameServer

func (s *SDK) GameServer() (*sdk.GameServer, error)

GameServer retrieve the GameServer details

func (*SDK) Health

func (s *SDK) Health() error

Health sends a ping to the health check to indicate that this server is healthy

func (*SDK) Ready

func (s *SDK) Ready() error

Ready marks the Game Server as ready to receive connections

func (*SDK) Shutdown

func (s *SDK) Shutdown() error

Shutdown marks the Game Server as ready to shutdown