View source

class AcknowledgeMessage

package feathers.messaging.messages

extends AsyncMessage › AbstractMessage

implements ISmallMessage

extended by ErrorMessage

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

An AcknowledgeMessage acknowledges the receipt of a message that was sent previously. Every message sent within the messaging system must receive an acknowledgement.

Static variables

@:value("DSErrorHint")staticfinalread onlyERROR_HINT_HEADER:String = "DSErrorHint"

Header name for the error hint header. Used to indicate that the acknowledgement is for a message that generated an error.

Constructor

new()

Constructs an instance of an AcknowledgeMessage with an empty body and header.

Methods

Inherited Variables

Defined by AsyncMessage

@:flash.propertycorrelationId:String

Provides access to the correlation id of the message. Used for acknowledgement and for segmentation of messages. The correlationId contains the messageId of the previous message that this message refers to.

See also:

  • feathers.messaging.messages.AbstractMessage#messageId

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.