Package VASSAL.chat.node

Class NodeClient

java.lang.Object

VASSAL.chat.node.NodeClient

All Implemented Interfaces:

ServerConnection, ChatServerConnection, LockableChatServerConnection, SocketWatcher, PlayerEncoder, ChatControlsInitializer

Direct Known Subclasses:

OfficialNodeClient, PrivateNodeClient

public class NodeClient
extends Object
implements LockableChatServerConnection, PlayerEncoder, ChatControlsInitializer, SocketWatcher

Author:

rkinney

Field Summary

Fields

Modifier and Type	Field	Description
protected NodeRoom[]	allRooms
protected MainRoomChecker	checker
protected int	compressionLimit
protected SimpleRoom	currentRoom
protected String	defaultRoomName
protected CommandEncoder	encoder
protected final String	host
protected InviteEncoder	inviteEncoder
protected NodePlayer	me
protected String	moduleName
protected PropertyChangeListener	nameChangeListener
protected NodeRoom	pendingSynchToRoom
protected String	playerId
protected SimpleStatusControlsInitializer	playerStatusControls
protected final int	port
protected PrivateChatEncoder	privateChatEncoder
protected PropertyChangeListener	profileChangeListener
protected PropertyChangeSupport	propSupport
protected RoomInteractionControlsInitializer	roomControls
protected SoundEncoder	soundEncoder
protected SynchEncoder	synchEncoder
protected final WelcomeMessageServer	welcomer
static final String	ZIP_HEADER

Fields inherited from interface VASSAL.chat.ChatServerConnection

AVAILABLE_ROOMS, DEFAULT_ROOM_NAME, INCOMING_MSG, PLAYER_INFO, ROOM, STATUS, STATUS_SERVER

Fields inherited from interface VASSAL.build.module.ServerConnection

CONNECTED, CONNECTION_LOST

Constructor Summary

Constructors

Constructor	Description
NodeClient(String moduleName, String playerId, CommandEncoder encoder, String host, int port, WelcomeMessageServer welcomer)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)	Register a PropertyChangeListener.
void	checkCompatibility(NodeRoom targetRoom, boolean compatible, List<String> errors)	Deprecated. Use boolean checkCompatibility(NodeRoom targetRoom, List errors)
boolean	checkCompatibility(NodeRoom targetRoom, List<String> errors)
static String	cleanVersion(String version)	Clean off an ' (Editing)' suffix added to the module version number
protected void	closeConnection()
void	doInvite(String playerId, String roomName)	Process an invitation request from a player to join a room
void	doKick(Player kickee)	Kick a player from this room
void	forward(String receipientPath, String msg)
Room[]	getAvailableRooms()	Return an array of all rooms on the server
String	getDefaultRoomName()	Return the name of the default room
NodePlayer	getMyInfo()
Room	getRoom()	Return the room currently occupied by the player
Player	getUserInfo()	Return a Player instance representing the current player
void	handleMessage(String msg)
void	handleMessageFromServer(String msg)	Process a message received from the server
protected void	initializeConnection()
void	initializeControls(ChatServerControls controls)	Register all event listeners
boolean	isConnected()
boolean	isDefaultRoom(Room r)	Is specified room the default room?
boolean	isInvitable(Player invitee)	Can a player be invited to this room by me?
boolean	isKickable(Player kickee)	Can a player be kicked from this room by me?
boolean	isOwner()	Return true if 1.
void	lockRoom(LockableRoom r)	Lock/Unlock the given room
String	playerToString(Player p)
protected void	registerNewConnection()
void	send(String command)
void	sendInvite(Player invitee)	Send Invitation to another player to join the current room
void	sendRoomInfo(NodeRoom r)
protected void	sendStats()
void	sendTo(Player recipient, Command c)	Send a Command to a particular player
void	sendToAll(String msg)
void	sendToOthers(String msg)
void	sendToOthers(Command c)	Send a command to other players on the server
void	setConnected(boolean connect)
void	setDefaultRoomName(String defaultRoomName)
void	setRoom(Room r)	Join the given room
void	setRoom(Room r, String password)
void	setUserInfo(Player p)	Set the Player instance representing this player
void	socketClosed(SocketHandler handler)
Player	stringToPlayer(String s)
void	uninitializeControls(ChatServerControls controls)	Remove all previously-registered event listeners
protected void	updateRooms(Node module)

Methods inherited from class java.lang.Object

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

Field Details

ZIP_HEADER

public static final String ZIP_HEADER

See Also:

• Constant Field Values

propSupport

protected PropertyChangeSupport propSupport

me

protected NodePlayer me

currentRoom

protected SimpleRoom currentRoom

defaultRoomName

protected String defaultRoomName

allRooms

protected NodeRoom[] allRooms

moduleName

protected String moduleName

playerId

protected String playerId

checker

protected MainRoomChecker checker

compressionLimit

protected int compressionLimit

encoder

protected CommandEncoder encoder

roomControls

protected RoomInteractionControlsInitializer roomControls

playerStatusControls

protected SimpleStatusControlsInitializer playerStatusControls

soundEncoder

protected SoundEncoder soundEncoder

privateChatEncoder

protected PrivateChatEncoder privateChatEncoder

synchEncoder

protected SynchEncoder synchEncoder

inviteEncoder

protected InviteEncoder inviteEncoder

nameChangeListener

protected PropertyChangeListener nameChangeListener

profileChangeListener

protected PropertyChangeListener profileChangeListener

pendingSynchToRoom

protected NodeRoom pendingSynchToRoom

host

protected final String host

port

protected final int port

welcomer

protected final WelcomeMessageServer welcomer

Constructor Details

NodeClient

public NodeClient(String moduleName,
 String playerId,
 CommandEncoder encoder,
 String host,
 int port,
 WelcomeMessageServer welcomer)

Method Details

setConnected

public void setConnected(boolean connect)

Specified by:

setConnected in interface ServerConnection

registerNewConnection

protected void registerNewConnection()

initializeConnection

protected void initializeConnection()
                             throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

closeConnection

protected void closeConnection()

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ServerConnection

socketClosed

public void socketClosed(SocketHandler handler)

Specified by:

socketClosed in interface SocketWatcher

send

public void send(String command)

setDefaultRoomName

public void setDefaultRoomName(String defaultRoomName)

getDefaultRoomName

public String getDefaultRoomName()

Description copied from interface: LockableChatServerConnection

Return the name of the default room

Specified by:

getDefaultRoomName in interface LockableChatServerConnection

isDefaultRoom

public boolean isDefaultRoom(Room r)

Description copied from interface: LockableChatServerConnection

Is specified room the default room?

Specified by:

isDefaultRoom in interface LockableChatServerConnection

sendStats

protected void sendStats()

isOwner

public boolean isOwner()

Return true if 1. The current room is the default room OR 2. The current player is the Owner of the current room

Returns:

true if this player owns the current room

sendToOthers

public void sendToOthers(Command c)

Description copied from interface: ServerConnection

Send a command to other players on the server

Specified by:

sendToOthers in interface ServerConnection

sendToAll

public void sendToAll(String msg)

forward

public void forward(String receipientPath,
 String msg)

sendToOthers

public void sendToOthers(String msg)

sendTo

public void sendTo(Player recipient,
 Command c)

Description copied from interface: ChatServerConnection

Send a Command to a particular player

Specified by:

sendTo in interface ChatServerConnection

doKick

public void doKick(Player kickee)

Description copied from interface: LockableChatServerConnection

Kick a player from this room

Specified by:

doKick in interface LockableChatServerConnection

isKickable

public boolean isKickable(Player kickee)

Description copied from interface: LockableChatServerConnection

Can a player be kicked from this room by me?

Specified by:

isKickable in interface LockableChatServerConnection

isInvitable

public boolean isInvitable(Player invitee)

Description copied from interface: LockableChatServerConnection

Can a player be invited to this room by me?

Specified by:

isInvitable in interface LockableChatServerConnection

sendInvite

public void sendInvite(Player invitee)

Send Invitation to another player to join the current room

Specified by:

sendInvite in interface LockableChatServerConnection

Parameters:

invitee - Player to invite

doInvite

public void doInvite(String playerId,
 String roomName)

Process an invitation request from a player to join a room

Specified by:

doInvite in interface LockableChatServerConnection

Parameters:

playerId - Inviting player name

roomName - Inviting room

getRoom

public Room getRoom()

Description copied from interface: ChatServerConnection

Return the room currently occupied by the player

Specified by:

getRoom in interface ChatServerConnection

getAvailableRooms

public Room[] getAvailableRooms()

Description copied from interface: ChatServerConnection

Return an array of all rooms on the server

Specified by:

getAvailableRooms in interface ChatServerConnection

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener l)

Description copied from interface: ServerConnection

Register a PropertyChangeListener. Changes to connection status triggers a PropertyChangeEvent, and concrete implementations may define other properties

Specified by:

addPropertyChangeListener in interface ServerConnection

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

getUserInfo

public Player getUserInfo()

Description copied from interface: ChatServerConnection

Return a Player instance representing the current player

Specified by:

getUserInfo in interface ChatServerConnection

getMyInfo

public NodePlayer getMyInfo()

setUserInfo

public void setUserInfo(Player p)

Description copied from interface: ChatServerConnection

Set the Player instance representing this player

Specified by:

setUserInfo in interface ChatServerConnection

lockRoom

public void lockRoom(LockableRoom r)

Description copied from interface: LockableChatServerConnection

Lock/Unlock the given room

Specified by:

lockRoom in interface LockableChatServerConnection

sendRoomInfo

public void sendRoomInfo(NodeRoom r)

setRoom

public void setRoom(Room r)

Description copied from interface: ChatServerConnection

Join the given room

Specified by:

setRoom in interface ChatServerConnection

setRoom

public void setRoom(Room r,
 String password)

handleMessageFromServer

public void handleMessageFromServer(String msg)

Process a message received from the server

Parameters:

msg - Encoded message

handleMessage

public void handleMessage(String msg)

Specified by:

handleMessage in interface SocketWatcher

updateRooms

protected void updateRooms(Node module)

stringToPlayer

public Player stringToPlayer(String s)

Specified by:

stringToPlayer in interface PlayerEncoder

playerToString

public String playerToString(Player p)

Specified by:

playerToString in interface PlayerEncoder

initializeControls

public void initializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Register all event listeners

Specified by:

initializeControls in interface ChatControlsInitializer

uninitializeControls

public void uninitializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Remove all previously-registered event listeners

Specified by:

uninitializeControls in interface ChatControlsInitializer

checkCompatibility

@Deprecated(since="2020-03-01")
public void checkCompatibility(NodeRoom targetRoom,
 boolean compatible,
 List<String> errors)

Deprecated.

Use boolean checkCompatibility(NodeRoom targetRoom, List errors)

Check on the compatibility of this client connecting to the target room. Check Vassal version, module version, module CRC

Parameters:

targetRoom - Room to be entered

compatible - Return true if entry allowed

errors - Return a list of error message if entry not allowed.

checkCompatibility

public boolean checkCompatibility(NodeRoom targetRoom,
 List<String> errors)

cleanVersion

public static String cleanVersion(String version)

Clean off an ' (Editing)' suffix added to the module version number

Parameters:

version -

Returns: