JSDoc: Class: Client

new Client(config)

Backgammon client

Parameters:

Name Type Description

config

Object

Configuration object

Properties

Name	Type	Description
`containerID`	string	ID of HTML container tag (defaults to 'backgammon')
`boardID`	string	ID of board tag (defaults to 'board')
`rulePath`	string	path to rules directory, relative to lib directory (defaults to './rules/')
`boardUI`	string	board UI filename, relative to project root (defaults to '../app/browser/js/SimpleBoardUI.js')

Source:

client.js, line 22

Members

_callbackList :Object

Map of callback functions to be executed after server replies to a message

Type:

Object

Source:

client.js, line 40

_clientMsgSeq :number

Counter used to generate unique sequence number for messages in client's session

Type:

number

Source:

client.js, line 34

_msgSubscriptions :Object

Dictionary of arrays, containing subscriptions for reception of messages by id/type. The key of the dictionary is the message ID. The value of the dictionary is an array with callback functions to execute when message is received.

Type:

Object

Source:

client.js, line 48

_socket :Socket

Client's socket object

Type:

Socket

Source:

client.js, line 28

config :Object

Default client configuration

Type:

Object

Source:

client.js, line 78

match :Match

Current match

Type:

Match

Source:

client.js, line 66

otherPlayer :Player

Other player object

Type:

Player

Source:

client.js, line 60

player :Player

Client's player object

Type:

Player

Source:

client.js, line 54

rule :Rule

Rule used in current match

Type:

Rule

Source:

client.js, line 72

Methods

_notify(msg, params)

Subscribe for notification on message reception

Parameters:

Name	Type	Description
`msg`	number	The ID of the message received
`params`	Object	Message parameters

Source:

client.js, line 591

_openSocket()

Prepare socket and attach message handlers

Source:

client.js, line 106

handleConnect()

Handle connection to server.

Source:

client.js, line 217

handleCreateGuest(params)

Handle reply - Guest player created

Parameters:

Name Type Description

params

Object

Message parameters

Properties

Name	Type	Description
`player`	Player	Player object created

Source:

client.js, line 313

handleCreateMatch(params)

Handle reply - New match has been created

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 346

handleEventDiceRoll(params)

Handle event - Dice rolled

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 420

handleEventGameOver(params)

Handle event - Game over. Current game is over. Prepare for next game of match, if any.

Parameters:

Name Type Description

params

Object

Message parameters

Properties

Name	Type	Description
`match`	number	Match that has been started

Source:

client.js, line 464

handleEventGameRestart(params)

Handle event - Game restart. Current game in match is over. Match is not finished, so start next game.

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 483

handleEventMatchOver(params)

Handle event - Match is over. Offer rematch or starting a new game.

Parameters:

Name Type Description

params

Object

Message parameters

Properties

Name	Type	Description
`match`	number	Match that has been started

Source:

client.js, line 474

handleEventMatchStart(params)

Handle event - Piece moved

Parameters:

Name Type Description

params

Object

Message parameters

Properties

Name	Type	Description
`match`	number	Match that has been started

Source:

client.js, line 442

handleEventPieceMove(params)

Handle event - Piece moved

Parameters:

Name Type Description

params

Object

Message parameters

Properties

Name	Type	Description
`position`	number	Position of piece being moved
`type`	PieceType	Type of piece being moved
`steps`	number	Number steps the piece is moved with
`moveActionList`	Array.<MoveAction>	List of actions that have to be played in UI

Source:

client.js, line 432

handleEventPlayerJoined(params)

Handle event - Another player joined match

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 400

handleEventTurnStart(params)

Handle event - New turn started

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 410

handleEventUndoMoves(params)

Handle event - Undo moves

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 493

handleGetMatchList(params)

Handle reply - List of matfches returned

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 329

handleJoinMatch(params)

Handle reply - Joined new match

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 362

handleMessage(msg, params)

Handle reply/event message.

Parameters:

Name	Type	Description
`msg`	string	Message ID
`params`	Object	Message parameters

Source:

client.js, line 230

handleMovePiece(params)

Handle reply - Piece moved

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 389

handlePlayRandom(params)

Handle reply - Start random match

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 338

handleRollDice(params)

Handle reply - Dice rolled

Parameters:

Name	Type	Description
`params`	Object	Message parameters

Source:

client.js, line 379

init(config)

Initialize client

Parameters:

Name Type Description

config

Object

Configuration object

Properties

Name	Type	Description
`containerID`	string	ID of HTML container tag (defaults to 'backgammon')
`boardID`	string	ID of board tag (defaults to 'board')
`rulePath`	string	path to rules directory, relative to lib directory (defaults to './rules/')
`boardUI`	string	board UI filename, relative to project root (defaults to '../app/browser/js/SimpleBoardUI.js')

Source:

client.js, line 93

loadRule(ruleName) → {Rule}

Load rule module

Parameters:

Name	Type	Description
`ruleName`	string	Rule's name, equal to rule's class name (eg. RuleBgCasual)

Source:

client.js, line 504

Returns:

- Corresponding rule object

Type: Rule

reqConfirmMoves(callbackopt)

Confirm moves made

Parameters:

Name	Type	Attributes	Description
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 662

reqCreateMatch(ruleName, callbackopt)

Request creating a new match.

Parameters:

Name	Type	Attributes	Description
`ruleName`	string		Name of rule to use (eg. RuleBgCasual)
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 625

reqJoinMatch(matchID, callbackopt)

Request joining a specific match.

Parameters:

Name	Type	Attributes	Description
`matchID`	number		ID of match to join
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 640

reqMove(piece, steps, callbackopt)

Request moving a piece.

Parameters:

Name	Type	Attributes	Description
`piece`	Piece		Denormalized position from which a piece has to be moved
`steps`	number		Number of steps to move forward to first home position
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 680

reqPlayRandom(ruleName, paramsopt, callbackopt)

Request playing a match with random player - from waiting queue.

Parameters:

Name	Type	Attributes	Description
`ruleName`	string		Name of rule to use (eg. RuleBgCasual)
`params`	Object	<optional>	Object map with message parameters
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 607

reqRollDice(callbackopt)

Request rolling dice

Parameters:

Name	Type	Attributes	Description
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 654

reqUndoMoves(callbackopt)

Undo moves made since last confirm

Parameters:

Name	Type	Attributes	Description
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply

Source:

client.js, line 670

resetBoard(match, rule)

Init game

Parameters:

Name	Type	Description
`match`	Match	Game
`rule`	Rule	Rule object to use

Source:

client.js, line 517

resizeUI()

Notify UI that DOM was rezised and UI may have to be updated

Source:

client.js, line 696

sendMessage(msg, paramsopt, callbackopt)

Send message to server.

Parameters:

Name	Type	Attributes	Description
`msg`	string		Message ID
`params`	Object	<optional>	Object map with message parameters
`callback`	messageCallback	<optional>	Callback function to be called when server sends a reply to this message

Source:

client.js, line 202

Subscribe for notification on message reception

Parameters:

Name	Type	Attributes	Description
`msgID`	number		The type of message to subscribe for
`callback`	messageCallback	<optional>	Callback function to be called on reception of this message

Source:

client.js, line 580

updateMatch(match)

Update match object. After an object has been updated, an update to UI should also be triggered.

Parameters:

Name	Type	Description
`match`	Match	Updated match object to use

Source:

client.js, line 550

updateOtherPlayer(player)

Update other player. After an object has been updated, an update to UI should also be triggered.

Parameters:

Name	Type	Description
`player`	Player	Updated other player's object to use

Source:

client.js, line 539

updatePlayer(player)

Update player. After an object has been updated, an update to UI should also be triggered.

Parameters:

Name	Type	Description
`player`	Player	Updated player's object to use

Source:

client.js, line 528

updateRule(rule)

Update rule object. After an object has been updated, an update to UI should also be triggered.

Parameters:

Name	Type	Description
`rule`	Rule	Updated rule object to use

Source:

client.js, line 562

updateUI()

Trigger update of board's UI.

Source:

client.js, line 570