| 套件 | mx.messaging |
| 類別 | public class MultiTopicConsumer |
| 繼承 | MultiTopicConsumer  AbstractConsumer MessageAgent EventDispatcher Object |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Like the regular Consumer, the MultiTopicConsumer sends subscribe and unsubscribe messages which generate a MessageAckEvent or MessageFaultEvent depending upon whether the operation was successful or not. Once subscribed, a MultiTopicConsumer dispatches a MessageEvent for each message it receives.
MXML 語法
顯示 MXML 語法
隱藏 MXML 語法The <mx:MultiTopicConsumer> tag has these properties:
<mx:Consumer
Properties
subscriptions=""an empty ArrayCollection of SubscriptionInfo objects"
resubscribeAttempts="5"
resubscribeInterval="5000"
timestamp="No default."
/>
| 屬性 | 定義自 | ||
|---|---|---|---|
 | authenticated : Boolean [唯讀]
Indicates if this MessageAgent is using an authenticated connection to
its destination. | MessageAgent | |
| channelSet : ChannelSet
Provides access to the ChannelSet used by the MessageAgent. | MessageAgent | |
| clientId : String [唯讀]
Provides access to the client id for the MessageAgent. | MessageAgent | |
| connected : Boolean [唯讀]
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. | MessageAgent | |
| constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | |
| destination : String
Provides access to the destination for the MessageAgent. | MessageAgent | |
| maxFrequency : uint
Determines the maximum number of messages per second the Consumer wants
to receive. | AbstractConsumer | |
| requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | MessageAgent | |
| resubscribeAttempts : int
The number of resubscribe attempts that the Consumer makes in the event
that the destination is unavailable or the connection to the destination fails. | AbstractConsumer | |
| resubscribeInterval : int
The number of milliseconds between resubscribe attempts. | AbstractConsumer | |
| subscribed : Boolean [唯讀]
Indicates whether the Consumer is currently subscribed. | AbstractConsumer | |
| subscriptions : ArrayCollection
Stores an Array of SubscriptionInfo objects. | MultiTopicConsumer | ||
| timestamp : Number
Contains the timestamp of the most recent message this Consumer
has received. | AbstractConsumer | |
| 方法 | 定義自 | ||
|---|---|---|---|
Constructor. | MultiTopicConsumer | ||
|
Invoked by a MessageResponder upon receiving a result for a sent
message. | MessageAgent | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | EventDispatcher | |
This is a convenience method for adding a new subscription. | MultiTopicConsumer | ||
|
Handles a CONNECT ChannelEvent. | MessageAgent | |
|
Handles a DISCONNECT ChannelEvent. | MessageAgent | |
|
Handles a ChannelFaultEvent. | MessageAgent | |
| [覆寫]
Disconnects the Consumer from its remote destination. | AbstractConsumer | |
|
會將事件傳送到事件流程。 | EventDispatcher | |
|
Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent | |
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | |
|
指出物件是否有已定義的指定屬性。 | Object | |
|
Returns true if there are any pending requests for the passed in message. | MessageAgent | |
|
Called after the implementing object has been created
and all properties specified on the tag have been assigned. | MessageAgent | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
|
Logs the MessageAgent out from its remote destination. | MessageAgent | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
Requests any messages that are queued for this Consumer on the server. | AbstractConsumer | |
|
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | |
This method removes the subscription specified by the subtopic
and selector. | MultiTopicConsumer | ||
|
Sets the credentials that the MessageAgent uses to authenticate to
destinations. | MessageAgent | |
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems. | MessageAgent | |
|
Subscribes to the remote destination. | AbstractConsumer | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
|
Unsubscribes from the remote destination. | AbstractConsumer | |
|
會傳回指定之物件的基本值。 | Object | |
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher | |
| 方法 | 定義自 | ||
|---|---|---|---|
[覆寫]
Returns a subscribe message. | MultiTopicConsumer | ||
[覆寫]
Returns an unsubscribe mesage. | MultiTopicConsumer | ||
|
Handles the authentication fault on the server. | MessageAgent | |
|
Used to automatically initialize the channelSet property for the
MessageAgent before it connects for the first time. | MessageAgent | |
|
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet. | MessageAgent | |
|
This function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them. | MessageAgent | |
| 事件 | 摘要 | 定義自 | ||
|---|---|---|---|---|
| Dispatched when an acknowledge message is received for a sent message. | MessageAgent | ||
| [廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。 | EventDispatcher | ||
| Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent | ||
| [廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。 | EventDispatcher | ||
| Dispatched when a message fault occurs. | MessageAgent | ||
| Dispatched when a message is received by the Consumer. | MultiTopicConsumer | |||
| Dispatched when the connected property of the MessageAgent changes. | MessageAgent | ||
subscriptions | 屬性 |
subscriptions:ArrayCollection| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Stores an Array of SubscriptionInfo objects. Each subscription contains a subtopic and a selector each of which can be null. A subscription with a non-null subtopic restricts the subscription to messages delivered with only that subtopic. If a subtopic is null, it uses the selector with no subtopic. If the selector and the subtopic is null, the subscription receives any messages targeted at the destination with no subtopic. The subtopic can contain a wildcard specification.
Before a call to the subscribe() method, this property
can be set with no side effects.
After the MultiTopicConsumer has subscribed to its destination, changing this
value has the side effect of updating the MultiTopicConsumer's subscription to
include any new subscriptions and remove any subscriptions you deleted from
the ArrayCollection.
The remote destination must understand the value of the selector expression.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 propertyChange 事件。
實作
public function get subscriptions():ArrayCollection public function set subscriptions(value:ArrayCollection):voidMultiTopicConsumer | () | 建構函式 |
public function MultiTopicConsumer()| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Constructor.
範例 ( 如何使用本範例 )
function initConsumer():void
{
var consumer:Consumer = new MultiTopicConsumer();
consumer.destination = "NASDAQ";
consumer.addEventListener(MessageEvent.MESSAGE, messageHandler);
consumer.addSubscription("myStock1", "operation IN ('BID', 'Ask')");
consumer.addSubscription("myStock2", "operation IN ('BID', 'Ask')");
consumer.subscribe();
}
function messageHandler(event:MessageEvent):void
{
var msg:IMessage = event.message;
var info:Object = msg.body;
trace("-App recieved message: " + msg.toString());
}
addSubscription | () | 方法 |
public function addSubscription(subtopic:String = null, selector:String = null, maxFrequency:uint = 0):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
This is a convenience method for adding a new subscription. It just creates a new SubscriptionInfo object and adds it to the subscriptions property. To call this method, you provide the subtopic and selector string for the new subscription. If the subtopic is null, the subscription applies to messages which do not have a subtopic set in the producer. If the selector string is null, all messages sent which match the subtopic string are received by this consumer.
參數
subtopic:String (default = null) | |
selector:String (default = null) | |
maxFrequency:uint (default = 0) |
buildSubscribeMessage | () | 方法 |
override protected function buildSubscribeMessage():CommandMessage| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Returns a subscribe message.
傳回值CommandMessage — The subscribe CommandMessage.
|
buildUnsubscribeMessage | () | 方法 |
override protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Returns an unsubscribe mesage.
參數
preserveDurable:Boolean — When true, durable JMS subscriptions are
not destroyed, allowing consumers to later resubscribe and
receive missed messages.
|
CommandMessage — The unsubscribe CommandMessage.
|
removeSubscription | () | 方法 |
public function removeSubscription(subtopic:String = null, selector:String = null):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
This method removes the subscription specified by the subtopic and selector.
參數
subtopic:String (default = null) | |
selector:String (default = null) |
message | 事件 |
mx.messaging.events.MessageEvent屬性 MessageEvent.type =
mx.messaging.events.MessageEvent.MESSAGE| 語言版本: | ActionScript 3.0 |
| 產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Dispatched when a message is received by the Consumer.
The MESSAGE event type; dispatched upon receipt of a message.The value of this constant is "message".
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
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. |
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. |
Tue Jun 12 2018, 03:47 PM Z