message

Documentation

Overview

Package message contains structures to pass between the ui and server.

Index

• func Send(m Message, out chan<- Message, debug bool, log log.Logger)
• type Addr
• type Message
• type Socket
• type Type

Functions

func Send

func Send(m Message, out chan<- Message, debug bool, log log.Logger)

Send is a utility function for sending messages. out on. When debugging, it prints a message before and after the message is sent to help identify deadlocks

Types

type Addr

type Addr string

Addr identifies the source of a message.

type Message

type Message struct {
	// Type is the purpose of the message.
	Type Type `json:"type"`
	// Info is a message to show to the player.
	Info string `json:"info,omitempty"`
	// Game is the info for the current game the player is in.
	Game *game.Info `json:"game,omitempty"`
	// Games contains the information about all the available games.
	Games []game.Info `json:"games,omitempty"`
	// PlayerName is the name of the player the message is to/from.
	PlayerName player.Name `json:"-"`
	// Addr is the socket remote address text the message is from.
	Addr Addr `json:"-"`
}

Message contains information to or from a socket for a game/lobby.

type Socket

type Socket struct {
	Type       Type
	PlayerName player.Name
	Result     chan<- error
	http.ResponseWriter
	*http.Request
}

Socket is used by the server lobby to ask the socket runner to change sockets.

type Type

type Type int

Type represents what the purpose of a message.

const (

	// CreateGame is a MessageType that users send to open a new game.
	CreateGame Type
	// JoinGame is a MessageType that users send to join a game or the server sends to have the user load a game.
	JoinGame
	// LeaveGame is a MessageType that users and servers send to indicate that a user can to longer be in the current game.
	LeaveGame
	// DeleteGame is a MessageType that users send to remove a game from the server.
	DeleteGame
	// GameChat is a MessageType that users send to communicate with ether players through the server.
	GameChat
	// RefreshGameBoard refreshes the board size for the current game by reading the NumCols and NumRows fields.
	RefreshGameBoard
	// ChangeGameStatus is a MessageType that users and servers send to request or inform of a game status change.
	ChangeGameStatus
	// ChangeGameTiles is a MessageType that the server sends to users to indicate that tiles have been changed for any player.
	ChangeGameTiles
	// SnagGameTile is a MessageType that users send to the server to request a new tile when they have none left to use.
	SnagGameTile
	// SwapGameTile is a MessageType that users send to the server to exchange a tile for three new ones.
	SwapGameTile
	// MoveGameTile is a MessageType that users send to the server whenever they change the state of their boards.
	MoveGameTile
	// GameInfos is a MessageType that the server sends to report changes in the games in a lobby.
	GameInfos
	// SocketWarning is a MessageType that servers send to inform users that a request is invalid.
	SocketWarning
	// SocketError is a MessageType that servers send to users to report an unexpected state.
	SocketError
	// SocketHTTPPing is a MessageType the server sends to the user to request a http request to the site to keep it active.  Some environments shut down after a period of HTTP inactivity has passed.
	SocketHTTPPing
	// SocketAdd is used to add a socket for a player.
	SocketAdd
	// SocketClose is sent when the socket is closed
	SocketClose
	// PlayerRemove is a MessageType that gets sent from the lobby to inform that all sockets should be removed.
	PlayerRemove // keep last for tests
)