Consumer

套件	mx.messaging
類別	public class Consumer
繼承	Consumer 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

A Consumer subscribes to a destination to receive messages. Consumers send subscribe and unsubscribe messages which generate a MessageAckEvent or MessageFaultEvent depending upon whether the operation was successful or not. Once subscribed, a Consumer dispatches a MessageEvent for each message it receives. Consumers provide the ability to filter messages using a selector. These selectors must be understood by the destination.

MXML 語法

隱藏 MXML 語法

The <mx:Consumer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <mx:Consumer
    Properties
    resubscribeAttempts="5"
    resubscribeInterval="5000"
    selector="No default."
    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
		selector : String The selector for the Consumer.	Consumer
		subscribed : Boolean [唯讀] Indicates whether the Consumer is currently subscribed.	AbstractConsumer
		subtopic : String Provides access to the subtopic for the remote destination that the MessageAgent uses.	Consumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	AbstractConsumer

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

	屬性		定義自
		_shouldBeSubscribed : Boolean Flag indicating whether this consumer should be subscribed or not.	AbstractConsumer

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") Constructor.	Consumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void 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
		channelConnectHandler(event:ChannelEvent):void Handles a CONNECT ChannelEvent.	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void Handles a DISCONNECT ChannelEvent.	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void Handles a ChannelFaultEvent.	MessageAgent
		disconnect():void [覆寫] Disconnects the Consumer from its remote destination.	AbstractConsumer
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		hasPendingRequestForMessage(msg:IMessage):Boolean Returns true if there are any pending requests for the passed in message.	MessageAgent
		initialized(document:Object, id:String):void Called after the implementing object has been created and all properties specified on the tag have been assigned.	MessageAgent
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		receive(timestamp:Number = 0):void Requests any messages that are queued for this Consumer on the server.	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void Sets the credentials that the MessageAgent uses to authenticate to destinations.	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void Sets the remote credentials that will be passed through to the remote destination for authenticating to secondary systems.	MessageAgent
		subscribe(clientId:String = null):void Subscribes to the remote destination.	AbstractConsumer
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		unsubscribe(preserveDurable:Boolean = false):void Unsubscribes from the remote destination.	AbstractConsumer
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

保護方法

隱藏繼承保護方法

顯示繼承保護方法

	方法		定義自
		buildSubscribeMessage():CommandMessage Returns a subscribe message.	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage Returns an unsubscribe message.	AbstractConsumer
		handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Handles the authentication fault on the server.	MessageAgent
		initChannelSet(message:IMessage):void Used to automatically initialize the channelSet property for the MessageAgent before it connects for the first time.	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void Sends a Message from the MessageAgent to its destination using the agent's ChannelSet.	MessageAgent
		reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them.	MessageAgent

事件

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

隱藏繼承事件

顯示繼承事件

	摘要	定義自
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
channelConnect	Dispatched when the underlying Channel the MessageAgent is using connects.	MessageAgent
channelDisconnect	Dispatched when the underlying Channel the MessageAgent is using disconnects.	MessageAgent
channelFault	Dispatched when the underlying Channel the MessageAgent is using faults.	MessageAgent
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher
fault	Dispatched when a message fault occurs.	MessageAgent
message	Dispatched when a message is received by the Consumer.	Consumer
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

屬性詳細資訊

selector

屬性

selector:String

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

The selector for the Consumer. This is an expression that is passed to the destination which uses it to filter the messages delivered to the Consumer.

Before a call to the subscribe() method, this property can be set with no side effects. After the Consumer has subscribed to its destination, changing this value has the side effect of updating the Consumer's subscription to use the new selector expression immediately.

The remote destination must understand the value of the selector expression.

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

實作
public function get selector():String
public function set selector(value:String):void

subtopic

屬性

subtopic:String

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Provides access to the subtopic for the remote destination that the MessageAgent uses.

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

實作
public function get subtopic():String
public function set subtopic(value:String):void

建構函式詳細資料

()

建構函式

public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Constructor.

參數

messageType:String (default = "flex.messaging.messages.AsyncMessage") — The alias for the message type processed by the service hosting the remote destination the Consumer will subscribe to. This parameter is deprecated and it is ignored by the constructor.

範例 ( 如何使用本範例 )

       function initConsumer():void
       {
           var consumer:Consumer = new Consumer();
           consumer.destination = "NASDAQ";
           consumer.selector = "operation IN ('Bid','Ask')";
           consumer.addEventListener(MessageEvent.MESSAGE, messageHandler);
           consumer.subscribe();
       }
     
       function messageHandler(event:MessageEvent):void
       {
           var msg:IMessage = event.message;
           var info:Object = msg.body;
           trace("-App recieved message: " + msg.toString());
       }

事件詳細資訊

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.

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

Consumer - AS3 BlazeDS LCDS

類別 x

selector

subtopic

Consumer

message