websocket

Documentation

Index

• Variables
• func BrillHeuristic(board []*Squares, color string) int
• func RandomColor() string
• type Chain
  • func (c *Chain) GetBoard() []*Squares
  • func (c *Chain) GetCols() int
  • func (c *Chain) GetRows() int
  • func (c *Chain) InitBoard(rows, cols int)
  • func (c *Chain) IsLegalMove(x, y int, color string) bool
  • func (c *Chain) Max(color, nextColor string, depth, alpha, beta, movedx, movedy int) (int, [2]int)
  • func (c *Chain) Min(color, nextColor string, depth, alpha, beta, movedx, movedy int) (int, [2]int)
  • func (c *Chain) MovePiece(x, y int, color string) ([][][]int, [][][]int)
  • func (c *Chain) RandMove(playerColor string) (int, int)
  • func (c *Chain) UpdateColor(newColor, oldColor string) bool
• type Client
  • func (bot *Client) HandleMsg(msg []byte)
  • func (c *Client) Move() Responder
  • func (bot *Client) PlayMove(playInfo *WSData)
  • func (c *Client) ReadMsg()
  • func (c *Client) WriteMsg()
• type Game
• type Hub
  • func NewHub(roomData *RoomData) *Hub
  • func (h *Hub) CloseChans()
  • func (h *Hub) End(color string) error
  • func (h *Hub) GetUniqueColor(c string) string
  • func (h *Hub) Run(roomStorage Storage, id string)
  • func (h *Hub) Update()
• type Responder
• type RoomData
• type Squares
• type Storage
• type WSData

Variables

var COLORS = []string{
	"Brown",
	"BlueViolet", "Red",
	"Aquamarine", "Green",
	"Brown", "DarkOrange",
	"DeepPink", "Gray",
	"Black", "darkkhaki",
	"Tan", "SlateBlue",
	"Tomato", "Cyan",
	"Olive", "cornsilk",
	"mediumspringgreen", "darkslategray",
	"peachpuff", "Maroon",
	"RosyBrown", "Yellow",
	"Magenta", "Indigo",
	"mediumvioletred", "Moccasin",
}

A Player can only be a color within this const

Functions

func BrillHeuristic

func BrillHeuristic(board []*Squares, color string) int

Heuristic from https://brilliant.org/wiki/chain-reaction-game/

func RandomColor

func RandomColor() string

RandomColor grabs a random color from global COLORS

Types

type Chain

type Chain struct {
	Len     int
	Squares []*Squares
	Hub     *Hub
}

Chain contains data relevant for Chain Reaction Game Satisfies the Game interface

func (*Chain) GetBoard

func (c *Chain) GetBoard() []*Squares

func (*Chain) GetCols

func (c *Chain) GetCols() int

GetCols is a requirement for Game interface GetCols Gets the cols in the Chain Board

func (*Chain) GetRows

func (c *Chain) GetRows() int

GetRows is a requirement for Game interface GetRows Gets the rows in the Chain Board

func (*Chain) InitBoard

func (c *Chain) InitBoard(rows, cols int)

InitBoard Creates a board with dimensions rows x cols

func (*Chain) IsLegalMove

func (c *Chain) IsLegalMove(x, y int, color string) bool

IsLegalMove Tells if a move is allowed Must be same color square or empty Cannot be off the board

func (*Chain) Max

func (c *Chain) Max(color, nextColor string, depth, alpha, beta, movedx, movedy int) (int, [2]int)

Maximizing player Return greatest number possible

func (*Chain) Min

func (c *Chain) Min(color, nextColor string, depth, alpha, beta, movedx, movedy int) (int, [2]int)

Minimizing player Return smallest number possible Look at Max() for more documentation

func (*Chain) MovePiece

func (c *Chain) MovePiece(x, y int, color string) ([][][]int, [][][]int)

MovePiece Moves the piece on the chain board. It will call the chained(explode) function to handle explosion. x - x coordinate of the user clicked square y - y coordinate of the user clicked square color - color of the user first return value is dynamic animation, second is the static position after an animation MovePiece is requirement for Game Interface. Animation data is data sent to Front end that will show animation. Moved / static data are the circles that remain from the explosion.

func (*Chain) RandMove

func (c *Chain) RandMove(playerColor string) (int, int)

func (*Chain) UpdateColor

func (c *Chain) UpdateColor(newColor, oldColor string) bool

UpdateColor updates squares controlled per client and sends a response results true if oldColor is dead / out of squares

type Client

type Client struct {
	// Username of the player
	Username string

	// The color that represents the player and on the board
	Color string

	// Can the player start the game or not?
	Leader bool

	// The hub in which clients will play
	Hub *Hub

	// The websocket connection.
	Conn *websocket.Conn

	// Buffered channel of outbound messages.
	Received chan []byte

	// channel to kill client. Only Used by botClients
	Stop chan bool
}

Client is a middleman between the websocket connection and the hub.

func (*Client) HandleMsg

func (bot *Client) HandleMsg(msg []byte)

func (*Client) Move

func (c *Client) Move() Responder

Function handles when a person moves Utilizes the Game interface to handle game logic. Sends response of animation data and new turn

func (*Client) PlayMove

func (bot *Client) PlayMove(playInfo *WSData)

func (*Client) ReadMsg

func (c *Client) ReadMsg()

ReadMsg Reads msg from the user and sends it to the hub Does the security checks and game checking

func (*Client) WriteMsg

func (c *Client) WriteMsg()

WriteMsg sends msg from the hub to the client Contains Ping Handler implementation. See RFC5.5.2 https://tools.ietf.org/html/rfc6455#section-5.5.2 for more info

type Game

type Game interface {
	InitBoard(int, int)
	MovePiece(int, int, string) ([][][]int, [][][]int)
	UpdateColor(string, string) bool
	GetRows() int
	GetCols() int
	GetBoard() []*Squares
	IsLegalMove(int, int, string) bool
	Minimax(string, bool, []string, int, int, int, int, int) (int, [2]int)
}

Game interface that provides functions that give general flow of a board game

type Hub

type Hub struct {
	// Tells http server if the Hub is running
	Alive bool
	// Channel telling server to remove id / kill the hub.
	Stop chan bool
	// Mapping of clients. int represents how many squares a person controls.
	Clients map[*Client]int
	// Channel to tell the http that a player left.
	Leaver chan bool
	// incoming broadcasting requests from clients.
	Broadcast chan []byte
	// Register requests from the clients.
	Register chan *Client
	// Unregister requests from clients.
	Unregister chan *Client

	// Move Order of players.
	Colors []string
	// Has the data of the room.
	RoomData *RoomData
	// Tracker of Game State. Called "Match" name to not confuse namespace.
	Match *Chain
	// contains filtered or unexported fields
}

Hub is the game server representative for individual games Handles killing itself, tracking the players, keeping data, broadcasting, registering, and unregistering

func NewHub

func NewHub(roomData *RoomData) *Hub

NewHub Creates a newHub for a game to take place in arbitrary large buffers to allow for async programming

func (*Hub) CloseChans

func (h *Hub) CloseChans()

Prevent any go specific memory leaks

func (*Hub) End

func (h *Hub) End(color string) error

Send Response to signal that game is over. Tell front end who the winner is.

func (*Hub) GetUniqueColor

func (h *Hub) GetUniqueColor(c string) string

GetUniqueColor grabs a unique from COLORS in utility.go

func (*Hub) Run

func (h *Hub) Run(roomStorage Storage, id string)

 Run is equivalent to turning on the computer
	Handles the registering, unregistering, and broadcasting
	Will kill itself when all the players leave

func (*Hub) Update

func (h *Hub) Update()

Update sends a Response to tell how many players are in teh lobby

type Responder

type Responder func(*WSData) error

function type that will deal with a specific msg from websocket function should be called by the type they handle

type RoomData

type RoomData struct {
	Room, Pin    string
	Players, Max int
	Roles        chan bool   // Send roles to other http handler
	Rolesws      chan bool   // send roles to handler of websockets
	Username     chan string // contains the names of people
	IsBot        bool        // Tells server if player is a bot
}

RoomData provides info about the room Will be for players trying to enter the room. Acts like a context for http server as well.

type Squares

type Squares struct {
	Len   int      // Length of a row
	Cur   []int    // How many circles are in the square
	Max   []int    // Carrying Capacity of the square
	Color []string // The color that occupies a square. "" if empty
}

Squares contains data about a row of squares Each index is a square

type Storage

type Storage map[string]*Hub

type WSData

type WSData struct {
	Type      string    `json:"type"`      // Type of message allows front end to know how to deal with the data
	X         int       `json:"x"`         // X coordinate clicked - "move"
	Y         int       `json:"y"`         // Y coordinate clicked - "move"
	Turn      string    `json:"turn"`      // players turn - "move"
	Animation [][][]int `json:"animation"` // Instrutios on animation - "move"
	Static    [][][]int `json:"static"`    // What the new board will look like - "move"
	Rows      int       `json:"rows"`      // Amount of rows - Sent at "start"
	Cols      int       `json:"cols"`      // Amount of columns - Sent at "start"
	Message   string    `json:"message"`   // chat messsage sent by a user - "chat"
	Color     string    `json:"color"`     // color of the person, used once - "color"
	Username  string    `json:"username"`  // username of each player
}

WSData provides allowed fields to be received from the front end Some other structs are used as single uses in other places in the code.