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

private java.lang.String

game Name of the new game.

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, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS, VERSION

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() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

getMaximumVersion, getMinimumVersion, getType, toMsg, toSingleElemArray

Methods inherited from class java.lang.Object

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

Field Detail

game

private java.lang.String game

Name of the new game.

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()

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