Packagecom.electrotank.electroserver4.message
Classpublic class MessageImpl
ImplementsMessage
SubclassesEventImpl, ResponseImpl

Establishes a base set of methods that are used for all requests, responses, and events.


Public Properties
 PropertyDefined by
  target : Object
MessageImpl
  type : String
MessageImpl
Public Methods
 MethodDefined by
  
MessageImpl()
MessageImpl
  
getIsRealServerMessage():Boolean
Used internally when one client-request needs to be remapped to a server request.
MessageImpl
  
getMessageId():Number
The id of the message.
MessageImpl
  
getMessageType():MessageType
The type of message being used.
MessageImpl
  
getRealMessage():Message
If this is not a real message, then get it.
MessageImpl
  
setIsRealServerMessage(isRealServerMessage:Boolean):void
Used internally when one client-request needs to be remapped to a server request.
MessageImpl
  
setMessageId(id:Number):void
The id of the message.
MessageImpl
  
setMessageType(mt:MessageType):void
This defines the type of message being used, such as LoginRequest or CreateRoomVariableRequest.
MessageImpl
  
validate():ValidationResponse
Every messages have varying optional fields.
MessageImpl
Property detail
targetproperty
public var target:Object
typeproperty 
public var type:String
Constructor detail
MessageImpl()constructor
public function MessageImpl()
Method detail
getIsRealServerMessage()method
public function getIsRealServerMessage():Boolean

Used internally when one client-request needs to be remapped to a server request.

Returns
Boolean — True or false.
getMessageId()method 
public function getMessageId():Number

The id of the message. Message ids are incremented so that message ordering is maintained.

Returns
Number — The id of the message.
getMessageType()method 
public function getMessageType():MessageType

The type of message being used.

Returns
MessageType — The type of message being used.
getRealMessage()method 
public function getRealMessage():Message

If this is not a real message, then get it.

Returns
Message — The real message.
setIsRealServerMessage()method 
public function setIsRealServerMessage(isRealServerMessage:Boolean):void

Used internally when one client-request needs to be remapped to a server request.

Parameters
isRealServerMessage:Boolean — True or false.
setMessageId()method 
public function setMessageId(id:Number):void

The id of the message. Message ids are incremented so that message ordering is maintained.

Parameters
id:Number — The id of the message.
setMessageType()method 
public function setMessageType(mt:MessageType):void

This defines the type of message being used, such as LoginRequest or CreateRoomVariableRequest.

Parameters
mt:MessageType — The type of message being used.
validate()method 
public function validate():ValidationResponse

Every messages have varying optional fields. This method applies validation to the message and returns a ValidationResponse with the results of that validation.

Returns
ValidationResponse — A ValidationResponse class instance.