Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ChannelFaultEvent

Package | mx.messaging.events
Class | public class ChannelFaultEvent
Inheritance | ChannelFaultEvent ChannelEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The ChannelFaultEvent class is used to propagate channel fault events within the messaging system.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | channel : Channel The Channel that generated this event. | ChannelEvent
|  | connected : Boolean Indicates whether the Channel that generated this event is already connected. | ChannelEvent
|  | faultCode : String Provides access to the destination-specific failure code. | ChannelFaultEvent
|  | faultDetail : String Provides destination-specific details of the failure. | ChannelFaultEvent
|  | faultString : String Provides access to the destination-specific reason for the failure. | ChannelFaultEvent
|  | reconnecting : Boolean Indicates whether the Channel that generated this event is reconnecting. | ChannelEvent
|  | rejected : Boolean Indicates whether the Channel that generated this event was rejected. | ChannelEvent
|  | rootCause : Object Provides access to the underlying reason for the failure if the channel did not raise the failure itself. | ChannelFaultEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | ChannelFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null, rejected:Boolean = false, connected:Boolean = false) Constructs an instance of this event with the specified type. | ChannelFaultEvent
|  | clone():Event [override] Clones the ChannelFaultEvent. | ChannelFaultEvent
|  | createErrorMessage():ErrorMessage Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage. | ChannelFaultEvent
|  | createEvent(channel:Channel, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null, rejected:Boolean = false, connected:Boolean = false):ChannelFaultEvent [static] Utility method to create a new ChannelFaultEvent that doesn't bubble and is not cancelable. | ChannelFaultEvent
|  | toString():String [override] Returns a string representation of the ChannelFaultEvent. | ChannelFaultEvent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CONNECT : String = channelConnect [static] The CONNECT event type; indicates that the Channel connected to its endpoint. | ChannelEvent
|  | DISCONNECT : String = channelDisconnect [static] The DISCONNECT event type; indicates that the Channel disconnected from its endpoint. | ChannelEvent
|  | FAULT : String = channelFault [static] The FAULT event type; indicates that the Channel faulted. | ChannelFaultEvent

Property Detail

faultCode | property

`public var faultCode:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 | property |

`public var faultDetail:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 | property |

`public var faultString:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the destination-specific reason for the failure.

See also

faultCode
faultDetail

rootCause | property |

`public var rootCause:Object`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the underlying reason for the failure if the channel did not raise the failure itself.

Constructor Detail

ChannelFaultEvent | () | Constructor

`public function ChannelFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null, rejected:Boolean = false, connected:Boolean = false)`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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:String` — The type of the event.
| `bubbles:Boolean` (default = `false`)`` — Indicates whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Indicates whether the behavior associated with the event can be prevented.
| `channel:Channel` (default = `null`)`` — The Channel generating the event.
| `reconnecting:Boolean` (default = `false`)`` — Indicates whether the Channel is in the process of reconnecting or not.
| `code:String` (default = `null`)`` — The fault code.
| `level:String` (default = `null`)`` — The fault level.
| `description:String` (default = `null`)`` — The fault description.
| `rejected:Boolean` (default = `false`)`` — Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection.
| `connected:Boolean` (default = `false`)`` — Indicates whether the Channel that generated this event is already connected.

Method Detail

clone | () | method

`override public function clone():Event`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Clones the ChannelFaultEvent.

Returns

| `Event` — Copy of this ChannelFaultEvent.

createErrorMessage | () | method |

`public function createErrorMessage():ErrorMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage.

Returns

| `ErrorMessage` — The ErrorMessage.

createEvent | () | method |

`public static function createEvent(channel:Channel, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null, rejected:Boolean = false, connected:Boolean = false):ChannelFaultEvent`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Utility method to create a new ChannelFaultEvent that doesn't bubble and is not cancelable.

Parameters

| `channel:Channel` — The Channel generating the event.
| `reconnecting:Boolean` (default = `false`)`` — Indicates whether the Channel is in the process of reconnecting or not.
| `code:String` (default = `null`)`` — The fault code.
| `level:String` (default = `null`)`` — The fault level.
| `description:String` (default = `null`)`` — The fault description.
| `rejected:Boolean` (default = `false`)`` — Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection.
| `connected:Boolean` (default = `false`)`` — Indicates whether the Channel that generated this event is already connected.

Returns

| `ChannelFaultEvent` — New ChannelFaultEvent.

toString | () | method |

`override public function toString():String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a string representation of the ChannelFaultEvent.

Returns

| `String` — String representation of the ChannelFaultEvent.

Constant Detail

FAULT | Constant

`public static const FAULT:String = channelFault`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

Sun Mar 5 2017, 03:42 PM +11:00