soc.message
Class SOCServerPing

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCServerPing

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCServerPing
extends SOCMessage

This is a ping message from the server, or its reply from the client.

In version 1.1.08 and higher, the client echoes the ping back to the server. Server can use this to ensure the client is still connected. If another client attempts to connect with the same name, same host (IP address), the first client will be pinged. If the client does not respond within a minute or so, it is replaced in all games by the newly connecting client. Server attempts to send a final SERVERPING to the old client, with sleepTime -1, to let it know it's no longer connected.

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private static long	serialVersionUID
(package private) int	sleepTime the ammount of time to sleep waiting for the next ping

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

SOCServerPing(int st)
Create a ServerPing message.

Method Summary

int	getSleepTime()
static SOCServerPing	parseDataStr(java.lang.String s) Parse the command String into a ServerPing message
java.lang.String	toCmd() SERVERPING sep sleepTime
static java.lang.String	toCmd(int st) SERVERPING sep sleepTime
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

sleepTime

int sleepTime

the ammount of time to sleep waiting for the next ping

Constructor Detail

SOCServerPing

public SOCServerPing(int st)

Create a ServerPing message.

Parameters:

st - the sleep time

Method Detail

getSleepTime

public int getSleepTime()

Returns:

the sleep time

toCmd

public java.lang.String toCmd()

SERVERPING sep sleepTime

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(int st)

SERVERPING sep sleepTime

Parameters:

st - the sleep time

Returns:

the command String

parseDataStr

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

Parse the command String into a ServerPing message

Parameters:

s - the String to parse

Returns:

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