soc.message
Class SOCAdminPing

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCAdminPing

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCAdminPing

extends SOCMessage

This message is a way for the admin to test if a robot is connected and running

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

SOCAdminPing(java.lang.String ga)
Create a AdminPing message.

Method Summary

java.lang.String	getGame()
static SOCAdminPing	parseDataStr(java.lang.String s) Parse the command String into a AdminPing message
java.lang.String	toCmd() ADMINPING sep game
static java.lang.String	toCmd(java.lang.String ga) ADMINPING sep game
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

SOCAdminPing

public SOCAdminPing(java.lang.String ga)

Create a AdminPing message.

Parameters:

ga - name of new game

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

toCmd

public java.lang.String toCmd()

ADMINPING sep game

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ga)

ADMINPING sep game

Parameters:

ga - the new game name

Returns:

the command string

parseDataStr

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

Parse the command String into a AdminPing message

Parameters:

s - the String to parse

Returns:

a AdminPing message

toString

public java.lang.String toString()

Returns:

a human readable form of the message