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

Consumer 订阅目标以接收消息。Consumer 发送生成 MessageAckEvent 或 MessageFaultEvent 的订阅和取消订阅消息，生成内容取决于操作是否成功。订阅后，Consumer 便会为它接收到的每条消息调度 MessageEvent。Consumer 提供使用选择器筛选消息的功能。目标必须了解这些选择器。

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 [只读] 指示此 MessageAgent 是否使用指向其目标的经过身份验证的连接。	MessageAgent
		channelSet : ChannelSet 提供对 MessageAgent 使用的 ChannelSet 的访问。	MessageAgent
		clientId : String [只读] 提供对 MessageAgent 的客户端 id 的访问。	MessageAgent
		connected : Boolean [只读] 指示此 MessageAgent 当前是否已通过其 ChannelSet 连接到了其目标。	MessageAgent
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		destination : String 提供对 MessageAgent 的目标的访问。	MessageAgent
		maxFrequency : uint 确定 Consumer 希望每秒钟收到的消息的最大数量。	AbstractConsumer
		requestTimeout : int 提供对已发送消息的请求超时（以秒为单位）的访问。	MessageAgent
		resubscribeAttempts : int Consumer 在目标不可用或连接到目标失败的情况下进行的重新订阅尝试次数。	AbstractConsumer
		resubscribeInterval : int 重新订阅尝试之间间隔的毫秒数。	AbstractConsumer
		selector : String Consumer 的选择器。	Consumer
		subscribed : Boolean [只读] 指示 Consumer 当前是否处于订阅状态。	AbstractConsumer
		subtopic : String 提供对 MessageAgent 使用的远程目标的 subtopic 的访问。	Consumer
		timestamp : Number 包含此 Consumer 接收到的最新消息的时间戳。	AbstractConsumer

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		_shouldBeSubscribed : Boolean 用于指示是否应订阅此使用者的标志。	AbstractConsumer

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") 构造函数。	Consumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void 收到已发送消息的结果时由 MessageResponder 调用。	MessageAgent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		channelConnectHandler(event:ChannelEvent):void 处理 CONNECT ChannelEvent。	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void 处理 DISCONNECT ChannelEvent。	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void 处理 ChannelFaultEvent。	MessageAgent
		disconnect():void [覆盖] 断开 Consumer 与其远程目标之间的连接。	AbstractConsumer
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void 收到已发送消息的错误时由 MessageResponder 调用。	MessageAgent
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		hasPendingRequestForMessage(msg:IMessage):Boolean 如果存在传入消息的任何挂起的请求，则返回 true。	MessageAgent
		initialized(document:Object, id:String):void 在创建了实现对象、并分配了标签上指定的所有属性后调用。	MessageAgent
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		logout():void 从其远程目标注销 MessageAgent。	MessageAgent
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		receive(timestamp:Number = 0):void 请求在服务器上为此 Consumer 排队的所有消息。	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void 设置 MessageAgent 用于对目标进行身份验证的凭据。	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void 设置将传递到远程目标以对次系统进行身份验证的远程凭据。	MessageAgent
		subscribe(clientId:String = null):void 订阅远程目标。	AbstractConsumer
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		unsubscribe(preserveDurable:Boolean = false):void 从远程目标取消订阅。	AbstractConsumer
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

受保护的方法

隐藏继承的受保护方法

显示继承的受保护方法

	方法		由以下参数定义
		buildSubscribeMessage():CommandMessage 返回订阅消息。	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage 返回取消订阅消息。	AbstractConsumer
		handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void 处理服务器上的身份验证错误。	MessageAgent
		initChannelSet(message:IMessage):void 用于首次连接之前自动初始化 MessageAgent 的 channelSet 属性。	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void 使用代理的 ChannelSet 将 Message 从 MessageAgent 发送到其目标。	MessageAgent
		reAuthorize(msg:IMessage):void 由于特定于子类的服务器会话超时行为，子类将覆盖此函数实现重新验证。	MessageAgent

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
acknowledge	收到已发送消息的确认消息时调度。	MessageAgent
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
channelConnect	MessageAgent 使用的基础 Channel 建立连接时调度。	MessageAgent
channelDisconnect	MessageAgent 使用的基础 Channel 断开连接时调度。	MessageAgent
channelFault	MessageAgent 使用的基础 Channel 出错时调度。	MessageAgent
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
fault	发生消息错误时调度。	MessageAgent
message	Consumer 接收到消息时调度。	Consumer
propertyChange	MessageAgent 的连接属性发生更改时调度。	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

Consumer 的选择器。这是传递到目标的表达式，目标将使用该表达式筛选传递到 Consumer 的消息。

调用 subscribe() 方法之前，可以设置此属性，且不会产生任何副作用。Consumer 订阅其目标后，更改此值会产生以下副作用：更新 Consumer 的订阅以立即使用新的选择器表达式。

远程目标必须了解选择器表达式的值。

此属性可用作数据绑定的源。修改此属性后，将调度 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

提供对 MessageAgent 使用的远程目标的 subtopic 的访问。

此属性可用作数据绑定的源。修改此属性后，将调度 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

构造函数。

参数

messageType:String (default = "flex.messaging.messages.AsyncMessage") — 消息类型别名，由承载 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());
       }

事件详细信息

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

Consumer 接收到消息时调度。

MESSAGE 事件类型；当收到消息时调度。

此常量的值为 "message"。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`message`	与此事件相关联的消息。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

法律声明 | 在线隐私策略

Consumer - AS3 BlazeDS LCDS

类 x

selector

subtopic

Consumer

message