MessageEvent Methods
MessageEvent() | Constructor for the MessageEvent class |
Thread() | Reference to the Thread object where the message was sent from |
ScriptName() | Name of the script that sent the message |
Address() | IP Address of the machine that sent the message |
Port() | TCP/IP Port on which the message was read |
MessageId() | Application specific integer value sent from the caller of the SendxxxMessage() method |
Derived Classes
TextMessageEvent, BinaryMessageEvent, ObjectMessageEvent
See Also
Class Hierarchy, Script, Thread
public method MessageEvent()
Parameters
None
Return Value
None
Description
Constructor for the MessageEvent class.
MessageEvent Class
public method<Thread> Thread()
Parameters
None
Return Value
Thread object where message originated
Description
This method returns a reference to the Thread object where the message was sent from. This will be null if the message came from a separate script.
MessageEvent Class
public method<string> ScriptName()
Parameters
None
Return Value
String containing the name of the Script that sent the message (empty if message originated in same script)
Description
This method returns the name of the executing Aztec script that sent this message. The name will be empty if it came from the same script that is handling the message.
MessageEvent Class
public method<string> Address()
Parameters
None
Return Value
String containing the IP address of the machine where the message came from (empty if message originated in same script)
Description
This method returns the IP address corresponding to the sender of the message. It will be empty if it came from the same script that is handling the message.
MessageEvent Class
public method<int> Port()
Parameters
None
Return Value
IP port number where the message came from (zero if message originated in same script)
Description
This method returns the IP port number where the message was read, if applicable. It will be zero if it came from the same script that is handling the message.
MessageEvent Class
public method<int>MessageId()
Parameters
None
Return Value
Application specific message ID value that was sent along with the message.
Description
This method returns the Message ID that was sent along with the message. A value of zero is used by default. This is an application specific integer value.
MessageEvent Class