server

package

v0.0.0-...-135d0e9 Latest Latest Go to latest Published: Nov 9, 2018 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package server provides a REST API for playing games.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Address string
	Hangman HangmanConfig
}

Config defines the main settings of the game server

func LoadConfig(paths ...string) (*Config, error)

LoadConfig loads a config from a local file or url

type HangmanConfig struct {
	Words []string
	Turns int
	// contains filtered or unexported fields
}

HangmanConfig defines the main settings for the Hangman game

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

Server is an instance of a REST gameserver.

func NewServer(cfg *Config) *Server

NewServer creates a new instance of Server with default in-memory storage,

func (s *Server) ListenAndServe() error

ListenAndServe starts the server. This function blocks until either Shutdown is called or the process is terminated.

func (s *Server) Shutdown()

Shutdown attempts a graceful shutdown of the server, timing out after 5 seconds.

func (s *Server) WithStore(store store.Store) *Server

WithStore overrides the default in-memory storage with a client-specified storage.