Class Protocol

java.lang.Object

VASSAL.chat.node.Protocol

public class Protocol
extends Object

Utility method for encoding server-related commands into strings. Messages sent or interpreted by the server are encoded here. Messages sent from one client to another are simply forwarded as strings without being decoded.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENTS
static final String	FORWARD
static final String	JOIN
static final String	KICK
static final String	LIST
static final String	LOGIN
static final String	NODE_INFO
static final String	REG_REQUEST
static final String	REGISTER
static final String	ROOM_INFO
static final String	STATS

Constructor Summary

Constructors

Constructor	Description
Protocol()

Method Summary

Modifier and Type	Method	Description
static String[]	decodeForwardCommand(String cmd)
static String[]	decodeJoinCommand(String cmd)
static String[]	decodeKickCommand(String cmd)
static Node	decodeListCommand(String cmd)
static String	decodeLoginCommand(String cmd)
static String[]	decodeNodeInfoCommand(String cmd)
static String[]	decodeRegisterCommand(String cmd)
static boolean	decodeRegisterRequest(String cmd)
static Properties	decodeRoomsInfo(String cmd)
static String[]	decodeStatsCommand(String cmd)
static String	encodeForwardCommand(String recipientPath, String message)	Forward a message to other client nodes
static String	encodeJoinCommand(String newParentPath)	Sent when a player wishes to join a room
static String	encodeJoinCommand(String newParentPath, String password)	Sent when a player is invited to join a locked room
static String	encodeKickCommand(String kickeeId)	Sent by the owner of a room to kick another player back to the Main Room
static String	encodeListCommand(Node[] nodes)	A dump of the current connections to the server.
static String	encodeLoginCommand(String username)	Sent when associating a connection with a given username
static String	encodeNodeInfoCommand(Node n)	Sent when the info for a particular (non-player) node is updated
static String	encodeRegisterCommand(String id, String initialPath, String info)	Contains registration information sent when a client initially connects to the server
static String	encodeRegisterRequest()
static String	encodeRoomsInfo(Node[] rooms)	Sent when a room's info changes, or to update all rooms' info at once
static String	encodeStatsCommand(String info)	Sent when a player updates his personal information

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REGISTER

public static final String REGISTER

See Also:

• Constant Field Values

REG_REQUEST

public static final String REG_REQUEST

See Also:

• Constant Field Values

JOIN

public static final String JOIN

See Also:

• Constant Field Values

FORWARD

public static final String FORWARD

See Also:

• Constant Field Values

STATS

public static final String STATS

See Also:

• Constant Field Values

LIST

public static final String LIST

See Also:

• Constant Field Values

CONTENTS

public static final String CONTENTS

See Also:

• Constant Field Values

NODE_INFO

public static final String NODE_INFO

See Also:

• Constant Field Values

ROOM_INFO

public static final String ROOM_INFO

See Also:

• Constant Field Values

LOGIN

public static final String LOGIN

See Also:

• Constant Field Values

KICK

public static final String KICK

See Also:

• Constant Field Values

Constructor Details

Protocol

public Protocol()

Method Details

encodeRegisterCommand

public static String encodeRegisterCommand(String id,
 String initialPath,
 String info)

Contains registration information sent when a client initially connects to the server

Parameters:

id -

initialPath -

info -

Returns:

decodeRegisterCommand

public static String[] decodeRegisterCommand(String cmd)

Returns:

senderId, newParentPath, senderInfo

See Also:

• encodeRegisterCommand(java.lang.String, java.lang.String, java.lang.String)

encodeJoinCommand

public static String encodeJoinCommand(String newParentPath)

Sent when a player wishes to join a room

Parameters:

newParentPath -

Returns:

encodeJoinCommand

public static String encodeJoinCommand(String newParentPath,
 String password)

Sent when a player is invited to join a locked room

Parameters:

newParentPath -

password -

Returns:

decodeJoinCommand

public static String[] decodeJoinCommand(String cmd)

Returns:

newParentPath

See Also:

• encodeJoinCommand(java.lang.String)

encodeForwardCommand

public static String encodeForwardCommand(String recipientPath,
 String message)

Forward a message to other client nodes

Parameters:

recipientPath - a path name specifying the indented recipients of the message

message -

Returns:

decodeForwardCommand

public static String[] decodeForwardCommand(String cmd)

Returns:

recipientPath, message

See Also:

• encodeForwardCommand(java.lang.String, java.lang.String)

encodeStatsCommand

public static String encodeStatsCommand(String info)

Sent when a player updates his personal information

Parameters:

info - the encoded properties of the PlayerNode corresponding to the player

Returns:

See Also:

• Node.setInfo(java.lang.String)

decodeStatsCommand

public static String[] decodeStatsCommand(String cmd)

Returns:

path, playerProperties

See Also:

• encodeStatsCommand(java.lang.String)

encodeNodeInfoCommand

public static String encodeNodeInfoCommand(Node n)

Sent when the info for a particular (non-player) node is updated

Parameters:

n -

Returns:

decodeNodeInfoCommand

public static String[] decodeNodeInfoCommand(String cmd)

Parameters:

cmd -

Returns:

path, info

See Also:

• encodeNodeInfoCommand(VASSAL.chat.node.Node)

encodeRoomsInfo

public static String encodeRoomsInfo(Node[] rooms)

Sent when a room's info changes, or to update all rooms' info at once

Parameters:

rooms -

Returns:

decodeRoomsInfo

public static Properties decodeRoomsInfo(String cmd)

encodeListCommand

public static String encodeListCommand(Node[] nodes)

A dump of the current connections to the server. Includes a path name and info for each player node

Parameters:

nodes -

Returns:

decodeListCommand

public static Node decodeListCommand(String cmd)

Parameters:

cmd -

Returns:

See Also:

• encodeListCommand(VASSAL.chat.node.Node[])

decodeRegisterRequest

public static boolean decodeRegisterRequest(String cmd)

encodeRegisterRequest

public static String encodeRegisterRequest()

encodeLoginCommand

public static String encodeLoginCommand(String username)

Sent when associating a connection with a given username

Parameters:

username -

See Also:

• ConnectionLimiter

decodeLoginCommand

public static String decodeLoginCommand(String cmd)

encodeKickCommand

public static String encodeKickCommand(String kickeeId)

Sent by the owner of a room to kick another player back to the Main Room

Parameters:

kickeeId -

Returns:

player

decodeKickCommand

public static String[] decodeKickCommand(String cmd)