View source

class RemotingMessage

package feathers.messaging.messages

extends AbstractMessage

@:directlyUsed@:meta(RemoteClass(alias = "flex.messaging.messages.RemotingMessage"))

RemotingMessages are used to send RPC requests to a remote endpoint. These messages use the operation property to specify which method to call on the remote object. The destination property indicates what object/service should be used.

Constructor

new()

Constructs an uninitialized RemotingMessage.

Variables

operation:String

Provides access to the name of the remote method/operation that should be called.

source:String

This property is provided for backwards compatibility. The best practice, however, is to not expose the underlying source of a RemoteObject destination on the client and only one source to a destination. Some types of Remoting Services may even ignore this property for security reasons.

Inherited Variables

Defined by AbstractMessage

@:flash.propertybody:Dynamic

The body of a message contains the specific data that needs to be delivered to the remote destination.

@:flash.propertyclientId:String

The clientId indicates which MessageAgent sent the message.

@:flash.propertydestination:String

The message destination.

@:flash.propertyheaders:Dynamic

The headers of a message are an associative array where the key is the header name and the value is the header value. This property provides access to the specialized meta information for the specific message instance. Core header names begin with a 'DS' prefix. Custom header names should start with a unique prefix to avoid name collisions.

@:flash.propertymessageId:String

The unique id for the message.

@:flash.propertytimeToLive:Float

The time to live value of a message indicates how long the message should be considered valid and deliverable. This value works in conjunction with the timestamp value. Time to live is the number of milliseconds that this message remains valid starting from the specified timestamp value. For example, if the timestamp value is 04/05/05 1:30:45 PST and the timeToLive value is 5000, then this message will expire at 04/05/05 1:30:50 PST. Once a message expires it will not be delivered to any other clients.

@:flash.propertytimestamp:Float

Provides access to the time stamp for the message. A time stamp is the date and time that the message was sent. The time stamp is used for tracking the message through the system, ensuring quality of service levels and providing a mechanism for message expiration.

See also:

Inherited Methods

Defined by AbstractMessage

toString():String

Returns a string representation of the message.

Returns:

String representation of the message.