The ErrorMessage class is used to report errors within the messaging system. An error message only occurs in response to a message sent within the system.

Static variables

@:value("Client.Error.DeliveryInDoubt")staticfinalread onlyMESSAGE_DELIVERY_IN_DOUBT:String = "Client.Error.DeliveryInDoubt"

If a message may not have been delivered, the faultCode will contain this constant.

@:value("DSRetryableErrorHint")staticfinalread onlyRETRYABLE_HINT_HEADER:String = "DSRetryableErrorHint"

Header name for the retryable hint header. This is used to indicate that the operation that generated the error may be retryable rather than fatal.

Constructor

new()

Constructs an ErrorMessage instance.

Variables

extendedData:Any

Extended data that the remote destination has chosen to associate with this error to facilitate custom error processing on the client.

faultCode:String

The fault code for the error. This value typically follows the convention of "[outer_context].[inner_context].[issue]". For example: "Channel.Connect.Failed", "Server.Call.Failed", etc.

faultDetail:String

Detailed description of what caused the error. This is typically a stack trace from the remote destination.

faultString:String

A simple description of the error.

rootCause:Any

Should a root cause exist for the error, this property contains those details. This may be an ErrorMessage, a NetStatusEvent info Object, or an underlying Flash error event: ErrorEvent, IOErrorEvent, or SecurityErrorEvent.

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 AcknowledgeMessage

Defined by AbstractMessage

toString():String

Returns a string representation of the message.

Returns:

String representation of the message.