ChannelSet

套件	mx.messaging
類別	public class ChannelSet
繼承	ChannelSet EventDispatcher Object
子類別	AdvancedChannelSet

語言版本:

ActionScript 3.0

產品版本:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

執行階段版本:

Flash Player 9, AIR 1.1

The ChannelSet is a set of Channels that are used to send messages to a target destination. The ChannelSet improves the quality of service on the client by hunting through its Channels to send messages in the face of network failures or individual Channel problems.

預設 MXML 屬性channels

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		authenticated : Boolean [唯讀] Indicates whether the ChannelSet has an underlying Channel that successfully authenticated with its endpoint.	ChannelSet
		channelIds : Array [唯讀] 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 [唯讀] Indicates whether the ChannelSet is connected.	ChannelSet
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		currentChannel : Channel [唯讀] 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 [唯讀] Provides access to the set of MessageAgents that use this ChannelSet.	ChannelSet

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false) Constructs a ChannelSet.	ChannelSet
		addChannel(channel:Channel):void Adds a Channel to the ChannelSet.	ChannelSet
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		channelConnectHandler(event:ChannelEvent):void Handles a CONNECT ChannelEvent and redispatches the event.	ChannelSet
		channelDisconnectHandler(event:ChannelEvent):void Handles a DISCONNECT ChannelEvent and redispatches the event.	ChannelSet
		channelFaultHandler(event:ChannelFaultEvent):void Handles a ChannelFaultEvent and redispatches the event.	ChannelSet
		connect(agent:MessageAgent):void Connects a MessageAgent to the ChannelSet.	ChannelSet
		disconnect(agent:MessageAgent):void Disconnects a specific MessageAgent from the ChannelSet.	ChannelSet
		disconnectAll():void Disconnects all associated MessageAgents and disconnects any underlying Channel that is connected.	ChannelSet
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		login(username:String, password:String, charset:String = null):mx.rpc:AsyncToken Authenticates the ChannelSet with the server using the provided credentials.	ChannelSet
		logout(agent:MessageAgent = null):mx.rpc:AsyncToken Logs the ChannelSet out from the server.	ChannelSet
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeChannel(channel:Channel):void Removes a Channel from the ChannelSet.	ChannelSet
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		send(agent:MessageAgent, message:IMessage):void Sends a message from a MessageAgent over the currently connected Channel.	ChannelSet
		setCredentials(credentials:String, agent:MessageAgent, charset:String = null):void Stores the credentials and passes them through to every connected channel.	ChannelSet
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String [覆寫] Returns a String containing the ids of the Channels in the ChannelSet.	ChannelSet
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

保護方法

	方法		定義自
		messageHandler(event:MessageEvent):void Redispatches message events from the currently connected Channel.	ChannelSet

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	摘要	定義自
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
channelConnect	Dispatched after a Channel in the ChannelSet has connected to its endpoint.	ChannelSet
channelDisconnect	Dispatched after a Channel in the ChannelSet has disconnected from its endpoint.	ChannelSet
channelFault	Dispatched after a Channel in the ChannelSet has faulted.	ChannelSet
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher
fault	The fault event is dispatched when a login or logout call fails.	ChannelSet
propertyChange	Dispatched when a property of the ChannelSet changes.	ChannelSet
result	The result event is dispatched when a login or logout call successfully returns.	ChannelSet

屬性詳細資訊

connected

屬性

connected:Boolean [唯讀]

Indicates whether the ChannelSet is connected.

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 propertyChange 事件。

實作
public function get connected():Boolean

heartbeatInterval

屬性

heartbeatInterval:int

The number of milliseconds between heartbeats sent to the remote host while this ChannelSet is actively connected but idle. Any outbound message traffic will delay heartbeats temporarily, with this number of milliseconds elapsing after the last sent message before the next heartbeat is issued.

This property is useful for applications that connect to a remote host to received pushed updates and are not actively sending any messages, but still wish to be notified of a dropped connection even when the networking layer fails to provide such notification directly. By issuing periodic heartbeats the client can force the networking layer to report a timeout if the underlying connection has dropped without notification and the application can respond to the disconnect appropriately.

Any non-positive value disables heartbeats to the remote host. The default value is 0 indicating that heartbeats are disabled. If the application sets this value it should prefer a longer rather than shorter interval, to avoid placing unnecessary load on the remote host. As an illustrative example, low-level TCP socket keep-alives generally default to an interval of 2 hours. That is a longer interval than most applications that enable heartbeats will likely want to use, but it serves as a clear precedent to prefer a longer interval over a shorter interval.

If the currently connected underlying Channel issues poll requests to the remote host, heartbeats are suppressed because the periodic poll requests effectively take their place.

實作
public function get heartbeatInterval():int
public function set heartbeatInterval(value:int):void

建構函式詳細資料

方法詳細資訊

logout

()

方法

public function logout(agent:MessageAgent = null):mx.rpc:AsyncToken

Logs the ChannelSet out from the server. Unlike other operations on Channels and the ChannelSet, this operation returns an AsyncToken that client code may add a responder to in order to handle success or failure directly. If logout is successful any credentials that have been cached for use in automatic reconnects are cleared for the ChannelSet and its Channels and their authenticated state is set to false. If the ChannelSet is not connected to the server when this method is invoked it will trigger a connect attempt, and if successful, send a logout command to the server.

The MessageAgent argument is present to support legacy logout behavior and client code that invokes this method should not pass a MessageAgent reference. Just invoke logout() passing no arguments.

This method is also invoked by service components from their logout() methods, and these components pass a MessageAgent reference to this method when they logout. The presence of this argument is the trigger to execute legacy logout behavior that differs from the new behavior described above. Legacy behavior only sends a logout request to the server if the client is connected and authenticated. If these conditions are not met the legacy behavior for this method is to do nothing other than clear any credentials that have been cached for use in automatic reconnects.

參數

agent:MessageAgent (default = null) — Legacy argument. The MessageAgent that is initiating the logout.

傳回值

mx.rpc:AsyncToken — Returns a token that client code may add a responder to in order to handle success or failure directly.

擲回值

IllegalOperationError — if a login or logout operation is currently in progress.

messageHandler

()

方法

protected function messageHandler(event:MessageEvent):void

Redispatches message events from the currently connected Channel.

參數

event:MessageEvent — The MessageEvent from the Channel.

事件詳細資訊

法律聲明 | 線上隱私權政策

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`.
`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.
`reconnecting`	Indicates whether the channel that generated this event is reconnecting.
`rejected`	Indicates whether the channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.

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`.
`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.
`reconnecting`	Indicates whether the channel that generated this event is reconnecting.
`rejected`	Indicates whether the channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.

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.

Property	Value
`bubbles`	false
`cancelable`	true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching 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`.
`fault`	The Fault object that contains the details of what caused this event.
`message`	The Message associated with this event.
`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.
`token`	The token that represents the call to the method. Used in the asynchronous completion token pattern.

Property	Value
`bubbles`	Determined by the constructor; defaults to false.
`cancelable`	Determined by the constructor; defaults to false.
`kind`	The kind of change; PropertyChangeEventKind.UPDATE or PropertyChangeEventKind.DELETE.
`oldValue`	The original property value.
`newValue`	The new property value, if any.
`property`	The property that changed.
`source`	The object that contains the property that changed.
`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`.
`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.

ChannelSet - AS3 BlazeDS LCDS

套件x

語言元素

附錄

套件 mx.messaging

authenticated

channelIds

channels

clustered

connected

currentChannel

heartbeatInterval

initialDestinationId

messageAgents

addChannel

channelConnectHandler

channelDisconnectHandler

channelFaultHandler

connect

disconnect

disconnectAll

login

logout

messageHandler

removeChannel

send

setCredentials

toString

channelConnect

channelDisconnect

channelFault

fault

propertyChange

result

	`channelIds:Array` (default = `null`) — The ids of configured Channels obtained from ServerConfig for this ChannelSet to use. If null, Channels must be manually added to the ChannelSet.

	`clusteredWithURLLoadBalancing:Boolean` (default = `false`) — True if the Channels in the ChannelSet are clustered using url load balancing.

	`username:String` — The username.

	`password:String` — The password.

	`charset:String` (default = `null`) — The character set encoding to use while encoding the credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other supported charset is "UTF-8".

	`agent:MessageAgent` — The MessageAgent sending the message.

	`message:IMessage` — The Message to send.

	`credentials:String` — The credentials for the MessageAgent.

	`agent:MessageAgent` — The MessageAgent that is setting the credentials.

	`charset:String` (default = `null`) — The character set encoding used while encoding the credentials. The default is null, which implies the legacy encoding of ISO-Latin-1.