| Package | mx.messaging |
| Class | public class AdvancedChannelSet |
| Inheritance | AdvancedChannelSet  ChannelSet EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Default MXML Propertychannels
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | authenticated : Boolean [read-only]
Indicates whether the ChannelSet has an underlying Channel that successfully
authenticated with its endpoint. | ChannelSet | |
| channelIds : Array [read-only]
The ids of the Channels used by the ChannelSet. | ChannelSet | |
| channels : Array
Provides access to the Channels in the ChannelSet. | ChannelSet | |
| clustered : Boolean
Indicates whether the ChannelSet targets a clustered destination. | ChannelSet | |
| connected : Boolean [read-only]
Indicates whether the ChannelSet is connected. | ChannelSet | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentChannel : Channel [read-only]
Returns the current Channel for the ChannelSet. | ChannelSet | |
| heartbeatInterval : int
The number of milliseconds between heartbeats sent to the remote
host while this ChannelSet is actively connected but idle. | ChannelSet | |
| initialDestinationId : String
Provides access to the initial destination this ChannelSet is used to access. | ChannelSet | |
| messageAgents : Array [read-only]
Provides access to the set of MessageAgents that use this ChannelSet. | ChannelSet | |
| reliableReconnectDuration : int
The duration in milliseconds that channels within the AdvancedChannelSet will
attempt to reconnect in a reliable fashion to the remote endpoint they
where previous connected to, before advancing to the normal automatic
failover and protocol fallback algorithm. | AdvancedChannelSet | ||
| Method | Defined By | ||
|---|---|---|---|
Constructs an AdvancedChannelSet. | AdvancedChannelSet | ||
|
Adds a Channel to the ChannelSet. | ChannelSet | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Handles a CONNECT ChannelEvent and redispatches the event. | ChannelSet | |
|
Handles a DISCONNECT ChannelEvent and redispatches the event. | ChannelSet | |
|
Handles a ChannelFaultEvent and redispatches the event. | ChannelSet | |
|
Connects a MessageAgent to the ChannelSet. | ChannelSet | |
|
Disconnects a specific MessageAgent from the ChannelSet. | ChannelSet | |
|
Disconnects all associated MessageAgents and disconnects any underlying Channel that
is connected. | ChannelSet | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Authenticates the ChannelSet with the server using the provided credentials. | ChannelSet | |
|
Logs the ChannelSet out from the server. | ChannelSet | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a Channel from the ChannelSet. | ChannelSet | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sends a message from a MessageAgent over the currently connected Channel. | ChannelSet | |
|
Stores the credentials and passes them through to every connected channel. | ChannelSet | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a String containing the ids of the Channels in the ChannelSet. | ChannelSet | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Constant | Defined By | ||
|---|---|---|---|
| MAX_REPLY_FETCH_INTERVAL_MILLIS : int = 30000 [static] | AdvancedChannelSet | ||
| ONE_SECOND_MILLIS : int = 1000 [static] | AdvancedChannelSet | ||
| RATE_SEPERATOR : String = "_;_" [static] | AdvancedChannelSet | ||
| START : String = "start" [static] | AdvancedChannelSet | ||
| STOP : String = "stop" [static] | AdvancedChannelSet | ||
| Constant | Defined By | ||
|---|---|---|---|
| ADAPTIVE_FREQUENCY_DESTINATION : String = "_DSAF" [static] | AdvancedChannelSet | ||
reliableReconnectDuration | property |
public var reliableReconnectDuration:intThe duration in milliseconds that channels within the AdvancedChannelSet will attempt to reconnect in a reliable fashion to the remote endpoint they where previous connected to, before advancing to the normal automatic failover and protocol fallback algorithm. The default value, 0, triggers a single reliable reconnect attempt. Assigned values must be 0 or greater and for any value larger than 0, in the event of a network disconnect, attempts will be made to re-establish the pre-existing reliable connection for the specified time duration in milliseconds.
Throws
RangeError — If a negative value is assigned.
|
AdvancedChannelSet | () | Constructor |
public function AdvancedChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false)| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an AdvancedChannelSet.
If the channelIds argument is provided, the AdvancedChannelSet will
use automatically configured Channels obtained via ServerConfig.getChannel()
to reach a destination.
Attempting to manually assign Channels to an AdvancedChannelSet that uses configured
Channels is not allowed.
If the channelIds argument is not provided or is null,
Channels must be manually created and added to the AdvancedChannelSet in order
to connect and send messages.
If the AdvancedChannelSet is clustered using url-load-balancing (where each server declares a unique RTMP or HTTP URL and the client fails over from one URL to the next), the first time that a Channel in the ChannelSet successfully connects the AdvancedChannelSet will automatically make a request for all of the endpoints across the cluster for all member Channels and will assign these failover URLs to each respective Channel. This allows Channels in the ChannelSet to failover individually, and when failover options for a specific Channel are exhausted the AdvancedChannelSet will advance to the next Channel in the set to attempt to reconnect.
Regardless of clustering, if a Channel cannot connect or looses connectivity, the AdvancedChannelSet will advance to its next available Channel and attempt to reconnect. This allows the AdvancedChannelSet to hunt through Channels that use different protocols, ports, etc., in search of one that can connect to its endpoint successfully.
ParameterschannelIds:Array (default = null) | |
clusteredWithURLLoadBalancing:Boolean (default = false) |
ADAPTIVE_FREQUENCY_DESTINATION | Constant |
protected static const ADAPTIVE_FREQUENCY_DESTINATION:String = "_DSAF"MAX_REPLY_FETCH_INTERVAL_MILLIS | Constant |
public static const MAX_REPLY_FETCH_INTERVAL_MILLIS:int = 30000ONE_SECOND_MILLIS | Constant |
public static const ONE_SECOND_MILLIS:int = 1000RATE_SEPERATOR | Constant |
public static const RATE_SEPERATOR:String = "_;_"START | Constant |
public static const START:String = "start"STOP | Constant |
public static const STOP:String = "stop"Wed Nov 21 2018, 06:34 AM -08:00