org.jogre.common.comm
Class CommDisconnect

java.lang.Object
  org.jogre.common.comm.CommBaseMessage
      org.jogre.common.comm.CommGameMessage
          org.jogre.common.comm.CommDisconnect

All Implemented Interfaces:

ITransmittable

public class CommDisconnect

extends CommGameMessage

Communication class which is used to disconnect a user from the system.

Version:

Alpha 0.2.1

Author:

Bob Marks

Field Summary

static int

CLIENT_DISCONNECT Status string that a user wishes to disconnect.

Fields inherited from class org.jogre.common.comm.CommGameMessage

gameID, LAYER, usernameTo, XML_ATT_GAME_ID

Fields inherited from class org.jogre.common.comm.CommBaseMessage

layer, status, username, XML_ATT_LAYER

Constructor Summary

CommDisconnect(int status)
Constructor which takes a status.

CommDisconnect(XMLElement message)
Constructor which creates a CommDisconnect object from the flatten () method of another CommDisconnect object.

Method Summary

XMLElement

flatten() Flatten disconnect object.

Methods inherited from class org.jogre.common.comm.CommGameMessage

flatten, getGameID, getUsernameTo, isUsernameToSet, setGameID

Methods inherited from class org.jogre.common.comm.CommBaseMessage

getStatus, getUsername, setUsername

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_DISCONNECT

public static final int CLIENT_DISCONNECT

Status string that a user wishes to disconnect.

See Also:

Constant Field Values

Constructor Detail

CommDisconnect

public CommDisconnect(int status)

Constructor which takes a status.

Parameters:

status -

CommDisconnect

public CommDisconnect(XMLElement message)
               throws TransmissionException

Constructor which creates a CommDisconnect object from the flatten () method of another CommDisconnect object.

Parameters:

message -

Throws:

TransmissionException

Method Detail

flatten

public XMLElement flatten()

Flatten disconnect object.

Returns:

XML version of the state of an object which can be constructed again.

See Also:

ITransmittable.flatten()