Aztec® Programming Language
Version 1.1 Alpha 2

Copyright © 2010-2017, Aztec Development Group, All Rights Reserved

Download Aztec

Search        Contact Us

Well they're sharing a drink they call loneliness...

But it's better than drinking alone.

- Billy Joel

 

aztec.system.MessageEvent

public class MessageEvent from<Event>

Base

Event

MessageEvent

MessageEvent is an abstract class which provides a simple framework for other message event classes, which includes text message, binary message and object message events. It provides basic information related to all message events. It also supports text and binary messages coming from other Aztec scripts, either on the same machine or on a different machine. The MessageClient.SendTextMessage() and MessageClient.SendBinaryMessage() methods are used to send messages from one Aztec script to another.

 

If the message comes from the same script as where it is handled, the ScriptName() and Address() methods will return empty strings. They are only populated when the message comes from a separate Aztec script..

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

See Also

  


MessageEvent()

public method MessageEvent()

Parameters

None

Return Value

None

Description

Constructor for the MessageEvent class.

 

MessageEvent Class


Thread()

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


ScriptName()

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


Address()

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


Port()

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


MessageId()

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

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec