core

Documentation

Index

• Variables
• type Client
  • func NewClient(ws *websocket.Conn, handlers []*CommandHandler) *Client
• type Command
• type CommandHandler
• type CommandJSON
• type ResponseJSON
• type Result
  • func NewErrorResult(data interface{}) *Result
  • func NewSuccessResult(data interface{}) *Result
• type Router
  • func NewRouter(handlers []*CommandHandler, c *Client) *Router
  • func (r *Router) Listen(conn *websocket.Conn)
  • func (r *Router) Send(cmd string, data interface{})
  • func (r *Router) SetHandlers(handlers []*CommandHandler)
• type Statistics
  • func (s *Statistics) AddPlayedGame()
  • func (s *Statistics) OnClientConnected()
  • func (s *Statistics) OnClientDisconnected()
  • func (s *Statistics) ToInfo() *StatisticsInfo
• type StatisticsInfo

Variables

var GameStats = Statistics{
	// contains filtered or unexported fields
}

GameStats holds current game statistics

Types

type Client

type Client struct {
	Name            string
	Router          *Router
	DefaultHandlers []*CommandHandler
}

Client stoers websocket and current routing data

func NewClient

func NewClient(ws *websocket.Conn, handlers []*CommandHandler) *Client

NewClient creates

type Command

type Command struct {
	Cmd  string      `json:"cmd"`
	Data interface{} `json:"data"`
}

Command is internal command structure, command usually are sent from server to client

type CommandHandler

type CommandHandler struct {
	Name   string
	Handle func(Data *json.RawMessage, p *Client) *Result
}

CommandHandler handles one command

type CommandJSON

type CommandJSON struct {
	Cmd  string           `json:"cmd"`
	Data *json.RawMessage `json:"data"`
}

CommandJSON is model for network commands

type ResponseJSON

type ResponseJSON struct {
	Cmd    string  `json:"cmd"`
	Result *Result `json:"result"`
}

ResponseJSON is sent over the web socket to client

type Result

type Result struct {
	Status int         `json:"status"`
	Data   interface{} `json:"data"`
}

Result is internal response from command handler

func NewErrorResult

func NewErrorResult(data interface{}) *Result

NewErrorResult creates result with error

func NewSuccessResult

func NewSuccessResult(data interface{}) *Result

NewSuccessResult creates success result

type Router

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

Router is set of command handlers

func NewRouter

func NewRouter(handlers []*CommandHandler, c *Client) *Router

NewRouter creates new router instance

func (*Router) Listen

func (r *Router) Listen(conn *websocket.Conn)

Listen handles web socket read

func (*Router) Send

func (r *Router) Send(cmd string, data interface{})

Send data to client

func (*Router) SetHandlers

func (r *Router) SetHandlers(handlers []*CommandHandler)

SetHandlers set new handlers for the router

type Statistics

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

Statistics hold game stats

func (*Statistics) AddPlayedGame

func (s *Statistics) AddPlayedGame()

AddPlayedGame increments played games count

func (*Statistics) OnClientConnected

func (s *Statistics) OnClientConnected()

OnClientConnected - call when client has connected

func (*Statistics) OnClientDisconnected

func (s *Statistics) OnClientDisconnected()

OnClientDisconnected - call when client disconnected

func (*Statistics) ToInfo

func (s *Statistics) ToInfo() *StatisticsInfo

ToInfo get StatisticsInfo intance for current Statistics

type StatisticsInfo

type StatisticsInfo struct {
	GamesPlayed      int64
	ClientsConnected int64
	Uptime           string
}

StatisticsInfo is serialized Statistics