game

Documentation

Index

• func ChooseText() (string, error)
• func Compose(t MessageType, payload string) []byte
• type Client
  • func (c *Client) ConfirmUsername(username string)
  • func (c *Client) Listen()
• type MessageType
  • func Parse(payload string) (MessageType, string)
• type Other
• type Server
  • func (s *Server) Accept()
  • func (s *Server) Inform(msg []byte)
  • func (s *Server) Listen(other *Other)
  • func (s *Server) StartGame()
  • func (s *Server) Subscribe(cb func(t MessageType))
• type State
  • func NewState(text string) *State
  • func (s *State) End()
  • func (s *State) IncError()
  • func (s *State) NextWord()
  • func (s State) Progress() float64
  • func (s *State) Start()
  • func (s State) Wpm() float64

Functions

func ChooseText

func ChooseText() (string, error)

ChooseText randomly chooses a text from the dataset

func Compose

func Compose(t MessageType, payload string) []byte

Compose creates a data string for connections

Types

type Client

type Client struct {
	// State stores State logic
	State *State
	// Name is the username
	Name string
	// Conn holds the connection to the server
	Conn net.Conn
}

Client is a state manager for the client

func (*Client) ConfirmUsername

func (c *Client) ConfirmUsername(username string)

ConfirmUsername sets a username and informs the server about it

func (*Client) Listen

func (c *Client) Listen()

Listen listens for messages

type MessageType

type MessageType string

MessageType defines available commands

const (
	// ChangeName is for changing usernames
	// payload = new username
	ChangeName MessageType = "change-name"
	// ExitPlayer is for players leaving the game
	// payload = nil
	ExitPlayer MessageType = "exit-player"
	// StartGame is for starting the game
	// payload = unix timestamp of when it starts
	StartGame MessageType = "start-game"
)

func Parse

func Parse(payload string) (MessageType, string)

Parse returns message type and message itself from a connection

type Other

type Other struct {
	// Conn holds the connection to the user
	Conn net.Conn
	// Name is the username
	Name string
	// Progress indicates how far is the user
	Progress float64
}

Other contains all information needed about other players

type Server

type Server struct {
	// State stores State logic
	State *State
	// Name is the username
	Name string
	// Server is an instance of net.Listener to control server logic
	Server net.Listener
	// Others has connection to clients
	Others []*Other
	// Callback is fired when a message comes
	Callback func(t MessageType)
}

Server is a state manager for the server

func (*Server) Accept

func (s *Server) Accept()

Accept listens for connections

func (*Server) Inform

func (s *Server) Inform(msg []byte)

Inform messages all clients about something

func (*Server) Listen

func (s *Server) Listen(other *Other)

Listen listens to messages from client

func (*Server) StartGame

func (s *Server) StartGame()

StartGame informs client the game is starting

func (*Server) Subscribe

func (s *Server) Subscribe(cb func(t MessageType))

Subscribe creates a callback

type State

type State struct {
	// CurrWord is an index to State.Words
	CurrWord int
	// Words contains the text split by spaces
	Words []string
	// StartTime is a timestamp of the first keystroke
	StartTime time.Time
	// contains filtered or unexported fields
}

State describes the state of a game

func NewState

func NewState(text string) *State

NewState initializes State

func (*State) End

func (s *State) End()

End ends the mechanism

func (*State) IncError

func (s *State) IncError()

IncError increments the error count

func (*State) NextWord

func (s *State) NextWord()

NextWord saves stats of the current word and increments the counter

func (State) Progress

func (s State) Progress() float64

Progress returns a float in the (0;1) range represending the progress made

func (*State) Start

func (s *State) Start()

Start starts the mechanism

func (State) Wpm

func (s State) Wpm() float64

Wpm is the words per minute