soc.message
Class SOCChannels

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCChannels

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCChannels
extends SOCMessage

This message lists all the chat channels on a server. It's one of the first messages sent from the server after SOCVersion when connecting. SOCChannels is sent even if the server isn't using SOCServerFeatures.FEAT_CHANNELS because clients see it as a signal the connection is complete, and display their main user interface panel.

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.util.Vector<java.lang.String>	channels List of channels
private static long	serialVersionUID

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, AUTHREQUEST, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BOARDLAYOUT2, BOARDSPECIALEDGE, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DEBUGFREEPLACE, DELETECHANNEL, DELETEGAME, DEVCARDACTION, DEVCARDCOUNT, DICERESULT, DICERESULTRESOURCES, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAME_NONE, GAMEMEMBERS, GAMEOPTIONGETDEFAULTS, GAMEOPTIONGETINFOS, GAMEOPTIONINFO, GAMES, GAMESERVERTEXT, GAMESTATE, GAMESTATS, GAMESWITHOPTIONS, GAMETEXTMSG, IMAROBOT, INVENTORYITEMACTION, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LEGALEDGES, LOCALIZEDSTRINGS, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEPIECE, MOVEPIECEREQUEST, MOVEROBBER, NEWCHANNEL, NEWGAME, NEWGAMEWITHOPTIONS, NEWGAMEWITHOPTIONSREQUEST, NULLMESSAGE, PICKRESOURCES, PICKRESOURCESREQUEST, PIECEVALUE, PLAYDEVCARDREQUEST, PLAYERELEMENT, PLAYERELEMENTS, PLAYERSTATS, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, REMOVEPIECE, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, REVEALFOGHEX, ROBOTDISMISS, ROBOTJOINGAMEREQUEST, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, SCENARIOINFO, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETSPECIALITEM, SETTURN, SETUPDONE, SIMPLEACTION, SIMPLEREQUEST, SITDOWN, STARTGAME, STATUSMESSAGE, SVPTEXTMSG, TEXTMSG, TIMINGPING, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCChannels(java.util.Vector<java.lang.String> cl)
Create a Channels Message.

Method Summary

java.util.Vector<java.lang.String>	getChannels()
static SOCChannels	parseDataStr(java.lang.String s) Parse the command String into a Channels message
java.lang.String	toCmd() CHANNELS sep channels
static java.lang.String	toCmd(java.util.Vector<java.lang.String> cl) CHANNELS sep channels
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, getMinimumVersion, getType, isSingleLineAndSafe, isSingleLineAndSafe, toMsg

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

channels

private java.util.Vector<java.lang.String> channels

List of channels

Constructor Detail

SOCChannels

public SOCChannels(java.util.Vector<java.lang.String> cl)

Create a Channels Message.

Parameters:

cl - list of channels

Method Detail

getChannels

public java.util.Vector<java.lang.String> getChannels()

Returns:

the list of channels

toCmd

public java.lang.String toCmd()

CHANNELS sep channels

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.util.Vector<java.lang.String> cl)

CHANNELS sep channels

Parameters:

cl - the list of channels

Returns:

the command string

parseDataStr

public static SOCChannels parseDataStr(java.lang.String s)

Parse the command String into a Channels message

Parameters:

s - the String to parse

Returns:

a Channels message, or null of the data is garbled

toString

public java.lang.String toString()

Description copied from class: SOCMessage

Simple human-readable representation, used for debug purposes.

Specified by:

toString in class SOCMessage

Returns:

a human readable form of the message