server

Documentation

Overview

Package server provides a restful TCP interface to manage bingo games and boards.

Index

• type Config
  • func (cfg Config) NewServer() (*Server, error)
  • func (Config) QRCode(text string, width, height int) (image.Image, error)
• type Server
  • func (s *Server) Run() <-chan error
  • func (s *Server) Shutdown(ctx context.Context) error

Types

type Config

type Config struct {
	// HTTPSRedirect causes the server to run a redirect from HTTPPORT to HTTPSPort when set
	HTTPSRedirect bool
	// HTTPPort is the HTTP port the server runs on.
	HTTPPort string
	// HTTPSPort is the HTTPS port the server runs on.
	HTTPSPort string
	// TLSCertFile is the public HTTPS TLS certificate file name.
	TLSCertFile string
	// TLSKeyFile is the private HTTPS TLS key file name.
	TLSKeyFile string
	// GameCount is the number of game states kept in the game list.
	GameCount int
	// Time is a function that can add a timestamp to parts of the site.
	Time func() string
}

Config is used to create a server.

func (Config) NewServer

func (cfg Config) NewServer() (*Server, error)

NewServer initializes HTTP and HTTPS TCP servers from the Configs

func (Config) QRCode

func (Config) QRCode(text string, width, height int) (image.Image, error)

QRCode uses a real qr code encoder to create an image of the desired size.

type Server

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

Server manages bingo games and creates boards.

func (*Server) Run

func (s *Server) Run() <-chan error

Run starts the HTTP and HTTPS TCP servers.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown waits for the HTTP and HTTPS servers to shut down.