The ChannelFaultEvent class is used to propagate channel fault events within the messaging system.
Static variables
staticfinalread onlyFAULT:String = "channelFault"
The FAULT event type; indicates that the Channel faulted.
The value of this constant is "channelFault".
The properties of the event object have the following values:
| Property | Value |
|---|---|
| `bubbles` | false |
| `cancelable` | false |
| `channel` | The Channel that generated this event. |
| `currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`. |
| `faultCode` | Provides destination-specific details of the failure. |
| `faultDetail` | Provides access to the destination-specific reason for the failure. |
| `faultString` | Provides access to the underlying reason for the failure if the channel did not raise the failure itself. |
| `reconnecting` | Indicates whether the channel that generated this event is reconnecting. |
| `rootCause` | Provides access to the underlying reason for the failure if the channel did not raise the failure itself. |
| `target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event. |
Static methods
staticcreateEvent(channel:Channel, reconnecting:Bool = false, ?code:String, ?level:String, ?description:String, rejected:Bool = false, connected:Bool = false):ChannelFaultEvent
Utility method to create a new ChannelFaultEvent that doesn't bubble and is not cancelable.
Parameters:
channel | The Channel generating the event. |
|---|---|
reconnecting | Indicates whether the Channel is in the process of reconnecting or not. |
code | The fault code. |
level | The fault level. |
description | The fault description. |
rejected | Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection. |
connected | Indicates whether the Channel that generated this event is already connected. |
Returns:
New ChannelFaultEvent.
Constructor
new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?channel:Channel, reconnecting:Bool = false, ?code:String, ?level:String, ?description:String, rejected:Bool = false, connected:Bool = false)
Constructs an instance of this event with the specified type.
Note that the rejected and connected arguments that correspond to properties
defined by the super-class ChannelEvent were not originally included in this method signature and have been
added at the end of the argument list to preserve backward compatibility even though this signature differs from
ChannelEvent's constructor.
Parameters:
type | The type of the event. |
|---|---|
bubbles | Indicates whether the event can bubble up the display list hierarchy. |
cancelable | Indicates whether the behavior associated with the event can be prevented. |
channel | The Channel generating the event. |
reconnecting | Indicates whether the Channel is in the process of reconnecting or not. |
code | The fault code. |
level | The fault level. |
description | The fault description. |
rejected | Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection. |
connected | Indicates whether the Channel that generated this event is already connected. |
Variables
faultCode:String
Provides access to the destination-specific failure code. For more
specific details see the faultString and
faultDetails properties.
The format of the fault codes are provided by the remote destination,
but will typically have the following form: host.operation.error
or Channel.operation.error.
For example, "Server.Connect.Failed" and Channel.Connect.Failed.
Channel.Connect.Failed is issued by the Channel class and its subclasses (RTMPChannel, AMFChannel, HTTPChannel, and so forth) whenever there is an issue in a Channel's connect attempts to the remote destination. Channel.Call.Failed is issued by the AMFChannel when the channel is already connected but it gets a Call.Failed code from its underlying NetConnection. Only the AMFChannel class listens for NetConnection.Call.Failed, which gets converted to Channel.Call.Failed.
See also:
faultString
faultDetail
faultDetail:String
Provides destination-specific details of the failure.
Typically fault details are a stack trace of an exception thrown at the remote destination.
See also:
faultString
faultCode
faultString:String
Provides access to the destination-specific reason for the failure.
See also:
faultCode
faultDetail
rootCause:Dynamic
Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
Methods
createErrorMessage():ErrorMessage
Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage.
Returns:
The ErrorMessage.
toString():String
Returns a string representation of the ChannelFaultEvent.
Returns:
String representation of the ChannelFaultEvent.