Package VASSAL.chat

Interface ChatServerConnection

All Superinterfaces:

ServerConnection

All Known Subinterfaces:

LockableChatServerConnection

All Known Implementing Classes:

ClientTest, DummyClient, DynamicClient, HybridClient, NodeClient, OfficialNodeClient, P2PClient, PrivateNodeClient

public interface ChatServerConnection
extends ServerConnection

Specialized interface for chat-room server connections

Author:

rkinney

Field Summary

Fields

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 VASSAL.build.module.ServerConnection

CONNECTED, CONNECTION_LOST

Method Summary

Modifier and Type	Method	Description
Room[]	getAvailableRooms()	Return an array of all rooms on the server
Room	getRoom()	Return the room currently occupied by the player
Player	getUserInfo()	Return a Player instance representing the current player
void	sendTo(Player recipient, Command c)	Send a Command to a particular player
void	setRoom(Room r)	Join the given room
void	setUserInfo(Player p)	Set the Player instance representing this player

Methods inherited from interface VASSAL.build.module.ServerConnection

addPropertyChangeListener, isConnected, sendToOthers, setConnected

Field Details

ROOM

static final String ROOM

Property representing the currently-occupied room

See Also:

• Constant Field Values

AVAILABLE_ROOMS

static final String AVAILABLE_ROOMS

Property representing the list of all rooms

See Also:

• Constant Field Values

STATUS

static final String STATUS

Property representing an informational message (e.g. "Connection succeeded")

See Also:

• Constant Field Values

PLAYER_INFO

static final String PLAYER_INFO

Property representing the current player's information

See Also:

• Constant Field Values

INCOMING_MSG

static final String INCOMING_MSG

Property representing a message received from the remove server

See Also:

• Constant Field Values

STATUS_SERVER

static final String STATUS_SERVER

Property representing the StatusServer implementation

See Also:

• Constant Field Values

DEFAULT_ROOM_NAME

static final String DEFAULT_ROOM_NAME

See Also:

• Constant Field Values

Method Details

getRoom

Room getRoom()

Return the room currently occupied by the player

setRoom

void setRoom(Room r)

Join the given room

getAvailableRooms

Room[] getAvailableRooms()

Return an array of all rooms on the server

getUserInfo

Player getUserInfo()

Return a Player instance representing the current player

setUserInfo

void setUserInfo(Player p)

Set the Player instance representing this player

sendTo

void sendTo(Player recipient,
 Command c)

Send a Command to a particular player