soc.message
Class SOCJoinGameRequest

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCJoinGameRequest

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCJoinGameRequest

extends SOCMessage

This message means that the server has authorized this client to join a game

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DELETECHANNEL, DELETEGAME, DEVCARD, DEVCARDCOUNT, DICERESULT, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAMEMEMBERS, GAMES, GAMESTATE, GAMESTATS, GAMETEXTMSG, IMAROBOT, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, JOINGAMEREQUEST, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEROBBER, NEWCHANNEL, NEWGAME, NULLMESSAGE, PLAYDEVCARDREQUEST, PLAYERELEMENT, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS

Constructor Summary

SOCJoinGameRequest(java.lang.String ga, int pn)
Create a JoinGameRequest message.

Method Summary

java.lang.String	getGame()
int	getPlayerNumber()
static SOCJoinGameRequest	parseDataStr(java.lang.String s) Parse the command String into a JoinGameRequest message
java.lang.String	toCmd() JOINGAMEREQUEST sep game sep2 playerNumber
static java.lang.String	toCmd(java.lang.String ga, int pn) JOINGAMEREQUEST sep game sep2 playerNumber
java.lang.String	toString()

Methods inherited from class soc.message.SOCMessage

getType, toMsg

Methods inherited from class java.lang.Object

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

Constructor Detail

SOCJoinGameRequest

public SOCJoinGameRequest(java.lang.String ga,
                          int pn)

Create a JoinGameRequest message.

Parameters:

ga - name of game

pn - the seat number

Method Detail

getGame

public java.lang.String getGame()

Returns:

the game name

getPlayerNumber

public int getPlayerNumber()

Returns:

the player seat number

toCmd

public java.lang.String toCmd()

JOINGAMEREQUEST sep game sep2 playerNumber

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn)

JOINGAMEREQUEST sep game sep2 playerNumber

Parameters:

ga - the game name

Returns:

the command string

parseDataStr

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

Parse the command String into a JoinGameRequest message

Parameters:

s - the String to parse

Returns:

a JoinGameRequest message, or null of the data is garbled

toString

public java.lang.String toString()

Returns:

a human readable form of the message