Class OfficialNodeClient

java.lang.Object

VASSAL.chat.node.NodeClient

VASSAL.chat.node.OfficialNodeClient

All Implemented Interfaces:

ServerConnection, ChatServerConnection, LockableChatServerConnection, SocketWatcher, PlayerEncoder, ChatControlsInitializer

public class OfficialNodeClient
extends NodeClient

Field Summary

Fields inherited from class NodeClient

allRooms, checker, compressionLimit, currentRoom, defaultRoomName, encoder, host, inviteEncoder, me, moduleName, nameChangeListener, pendingSynchToRoom, playerId, playerStatusControls, port, privateChatEncoder, profileChangeListener, propSupport, roomControls, soundEncoder, synchEncoder, welcomer, ZIP_HEADER

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 ChatServerConnection

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

Modifier and Type	Field	Description
static final String	AVAILABLE_ROOMS	Property representing the list of all rooms
static final String	DEFAULT_ROOM_NAME
static final String	INCOMING_MSG	Property representing a message received from the remove server
static final String	PLAYER_INFO	Property representing the current player's information
static final String	ROOM	Property representing the currently-occupied room
static final String	STATUS	Property representing an informational message (e.g.
static final String	STATUS_SERVER	Property representing the StatusServer implementation

Fields inherited from interface ServerConnection

CONNECTED, CONNECTION_LOST

Modifier and Type	Field	Description
static final String	CONNECTED	Name of the property fired when the connection is opened/closed.
static final String	CONNECTION_LOST

Constructor Summary

Constructors

Constructor	Description
OfficialNodeClient(String moduleName, String playerId, CommandEncoder encoder, String host, int port, MessageBoard msgSvr, WelcomeMessageServer welcomer)

Method Summary

Modifier and Type	Method	Description
void	initializeControls(ChatServerControls controls)	Register all event listeners
void	uninitializeControls(ChatServerControls controls)	Remove all previously-registered event listeners

Methods inherited from class NodeClient

addPropertyChangeListener, addPropertyChangeListener, checkCompatibility, checkCompatibility, cleanVersion, closeConnection, doInvite, doKick, forward, getAvailableRooms, getDefaultRoomName, getMyInfo, getRoom, getUserInfo, handleMessage, handleMessageFromServer, initializeConnection, isConnected, isDefaultRoom, isInvitable, isKickable, isOwner, lockRoom, playerToString, registerNewConnection, send, sendInvite, sendRoomInfo, sendStats, sendTo, sendToAll, sendToOthers, sendToOthers, setConnected, setDefaultRoomName, setRoom, setRoom, setUserInfo, socketClosed, stringToPlayer, updateRooms

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 recipientPath, 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()
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)
protected void	updateRooms(Node module)

Methods inherited from class Object

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

Constructor Details

OfficialNodeClient

public OfficialNodeClient(String moduleName,
 String playerId,
 CommandEncoder encoder,
 String host,
 int port,
 MessageBoard msgSvr,
 WelcomeMessageServer welcomer)

Method Details

initializeControls

public void initializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Register all event listeners

Specified by:

initializeControls in interface ChatControlsInitializer

Overrides:

initializeControls in class NodeClient

uninitializeControls

public void uninitializeControls(ChatServerControls controls)

Description copied from interface: ChatControlsInitializer

Remove all previously-registered event listeners

Specified by:

uninitializeControls in interface ChatControlsInitializer

Overrides:

uninitializeControls in class NodeClient