soc.message
Class SOCJoin

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCJoin

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCJoin
extends SOCMessage

This message means that someone is joining a channel

Once the client has successfully joined or created a channel or game, the password field can be left blank in later join/create requests. All server versions ignore the password field after a successful request.

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	channel Name of channel
private java.lang.String	host Server host name to which the client is connecting.
private java.lang.String	nickname Nickname of the joining member
private static java.lang.String	NULLPASS symbol to represent a null or empty password over the network, to avoid 2 adjacent field-delimiter characters
private java.lang.String	password Optional password, or "" if none
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

SOCJoin(java.lang.String nn, java.lang.String pw, java.lang.String hn, java.lang.String ch)
Create a Join Channel message.

Method Summary

java.lang.String	getChannel()
java.lang.String	getHost() Get the server host name to which the client is connecting.
java.lang.String	getNickname()
java.lang.String	getPassword()
static SOCJoin	parseDataStr(java.lang.String s) Parse the command String into a Join Channel message.
java.lang.String	toCmd() JOIN sep nickname sep2 password sep2 host sep2 channel
static java.lang.String	toCmd(java.lang.String nn, java.lang.String pw, java.lang.String hn, java.lang.String ch) JOIN sep nickname sep2 password sep2 host sep2 channel
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

NULLPASS

private static java.lang.String NULLPASS

symbol to represent a null or empty password over the network, to avoid 2 adjacent field-delimiter characters

nickname

private java.lang.String nickname

Nickname of the joining member

password

private java.lang.String password

Optional password, or "" if none

channel

private java.lang.String channel

Name of channel

host

private java.lang.String host

Server host name to which the client is connecting. Since the client is already connected when it sends the message, this is informational.

Constructor Detail

SOCJoin

public SOCJoin(java.lang.String nn,
               java.lang.String pw,
               java.lang.String hn,
               java.lang.String ch)

Create a Join Channel message.

Parameters:

nn - nickname

pw - optional password, or "" if none

hn - server host name

ch - name of chat channel

Method Detail

getNickname

public java.lang.String getNickname()

Returns:

the nickname

getPassword

public java.lang.String getPassword()

Returns:

the optional password, or "" if none

getHost

public java.lang.String getHost()

Get the server host name to which the client is connecting. Since the client is already connected when it sends the message, this is only informational.

Returns:

the host name

getChannel

public java.lang.String getChannel()

Returns:

the channel name

toCmd

public java.lang.String toCmd()

JOIN sep nickname sep2 password sep2 host sep2 channel

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String nn,
                                     java.lang.String pw,
                                     java.lang.String hn,
                                     java.lang.String ch)

JOIN sep nickname sep2 password sep2 host sep2 channel

Parameters:

nn - the nickname

pw - the optional password, or "" if none

hn - the server host name

ch - the channel name

Returns:

the command string

parseDataStr

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

Parse the command String into a Join Channel message.

Parameters:

s - the String to parse

Returns:

a Join 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