AbstractConsumer

套件	mx.messaging
類別	public class AbstractConsumer
繼承	AbstractConsumer MessageAgent EventDispatcher Object
子類別	Consumer, MultiTopicConsumer

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

The AbstractConsumer is the base class for both the Consumer and MultiTopicConsumer classes. You use those classes to receive pushed messages from the server.

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		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
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		AbstractConsumer() Constructs a Consumer.	AbstractConsumer
		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.	AbstractConsumer
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

屬性詳細資訊

_shouldBeSubscribed

屬性

protected var _shouldBeSubscribed:Boolean

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Flag indicating whether this consumer should be subscribed or not.

maxFrequency

屬性

maxFrequency:uint

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Determines the maximum number of messages per second the Consumer wants to receive. A server that understands this value will use it as an input while it determines how fast to send messages to the Consumer. Default is 0 which means Consumer does not have a preference for the message rate. Note that this property should be set before the Consumer subscribes and any changes after Consumer subscription will not have any effect until Consumer unsubscribes and resubscribes.

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

實作
public function get maxFrequency():uint
public function set maxFrequency(value:uint):void

resubscribeAttempts

屬性

resubscribeAttempts:int

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

The number of resubscribe attempts that the Consumer makes in the event that the destination is unavailable or the connection to the destination fails. A value of -1 enables infinite attempts. A value of zero disables resubscribe attempts.

Resubscribe attempts are made at a constant rate according to the resubscribe interval value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails.

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

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

resubscribeInterval

屬性

resubscribeInterval:int

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

The number of milliseconds between resubscribe attempts. If a Consumer doesn't receive an acknowledgement for a subscription request, it will wait the specified number of milliseconds before attempting to resubscribe. Setting the value to zero disables resubscriptions.

Resubscribe attempts are made at a constant rate according to this value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails.

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

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

擲回值

ArgumentError — If the assigned value is negative.

subscribed

屬性

subscribed:Boolean [唯讀]

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Indicates whether the Consumer is currently subscribed. The propertyChange event is dispatched when this property changes.

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

實作
public function get subscribed():Boolean

timestamp

屬性

timestamp:Number

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Contains the timestamp of the most recent message this Consumer has received. This value is passed to the destination in a receive() call to request that it deliver messages for the Consumer from the timestamp forward. All messages with a timestamp value greater than the timestamp value will be returned during a poll operation. Setting this value to -1 will retrieve all cached messages from the destination.

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

實作
public function get timestamp():Number
public function set timestamp(value:Number):void

建構函式詳細資料

()

建構函式

public function AbstractConsumer()

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Constructs a Consumer.

範例 ( 如何使用本範例 )

       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());
       }

方法詳細資訊

buildSubscribeMessage

()

方法

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. This method should be overridden by subclasses if they need custom subscribe messages.

傳回值

CommandMessage — The subscribe CommandMessage.

buildUnsubscribeMessage

()

方法

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 message. This method should be overridden by subclasses if they need custom unsubscribe messages.

參數

preserveDurable:Boolean — - when true, durable JMS subscriptions are not destroyed allowing consumers to later resubscribe and receive missed messages

傳回值

CommandMessage — The unsubscribe CommandMessage.

disconnect

()

方法

override public function disconnect():void

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Disconnects the Consumer from its remote destination. This method should be invoked on a Consumer that is no longer needed by an application after unsubscribing. This method does not wait for outstanding network operations to complete and does not send an unsubscribe message to the server. After invoking disconnect(), the Consumer will report that it is in an disconnected, unsubscribed state because it will not receive any more messages until it has reconnected and resubscribed. Disconnecting stops automatic resubscription attempts if they are running.

receive

()

方法

public function receive(timestamp:Number = 0):void

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Requests any messages that are queued for this Consumer on the server. This method should only be used for Consumers that subscribe over non-realtime, non-polling channels. This method is a no-op if the Consumer is not subscribed.

參數

timestamp:Number (default = 0) — This argument is deprecated and is ignored.

()

方法

public function subscribe(clientId:String = null):void

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Subscribes to the remote destination.

參數

clientId:String (default = null) — The client id to subscribe with. Use null for non-durable Consumers. If the subscription is durable, a consistent value must be supplied every time the Consumer subscribes in order to reconnect to the correct durable subscription in the remote destination.

擲回值

InvalidDestinationError — If no destination is set.

unsubscribe

()

方法

public function unsubscribe(preserveDurable:Boolean = false):void

語言版本:

ActionScript 3.0

產品版本:

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

執行階段版本:

Flash Player 9, AIR 1.1

Unsubscribes from the remote destination. In the case of durable JMS subscriptions, this will destroy the durable subscription on the JMS server.

參數

preserveDurable:Boolean (default = false) — - when true, durable JMS subscriptions are not destroyed allowing consumers to later resubscribe and receive missed messages

事件詳細資訊

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.

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

AbstractConsumer - AS3 BlazeDS LCDS

類別 x

_shouldBeSubscribed

maxFrequency

resubscribeAttempts

resubscribeInterval

subscribed

timestamp