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

Получатель подписывается на адрес назначения для получения сообщений. Получатели отправляют сообщения о подписке и отмене подписки, которые генерируют MessageAckEvent или MessageFaultEvent в зависимости от того, была эта операция выполнена успешно или нет. После подписки получатель передает MessageEvent для каждого получаемого им сообщения. Получатели предоставляют возможность фильтровать сообщения с помощью селектора. Эти селекторы должны быть известны адресату.

Синтаксис MXML expanded

Скрыть синтаксис 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 Предоставляет доступ к ChannelSet, который используется MessageAgent.	MessageAgent
		clientId : String [только для чтения] Предоставляет доступ к идентификатору клиента для MessageAgent.	MessageAgent
		connected : Boolean [только для чтения] Указывает, подключен ли этот MessageAgent в настоящее время к адресату через соответствующий ChannelSet.	MessageAgent
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		destination : String Предоставляет доступ к адресату для MessageAgent.	MessageAgent
		maxFrequency : uint Определяет максимальное количество сообщений в секунду, установленное получателем.	AbstractConsumer
		requestTimeout : int Предоставляет доступ к тайм-ауту запроса в секундах для переданных сообщений.	MessageAgent
		resubscribeAttempts : int Количество выполняемых получателем повторных попыток подписки при недоступном адресате или при ошибке подключения к адресату.	AbstractConsumer
		resubscribeInterval : int Количество миллисекунд между повторными попытками подписки.	AbstractConsumer
		selector : String Селектор для получателя.	Consumer
		subscribed : Boolean [только для чтения] Указывает, подписан ли в настоящее время получатель.	AbstractConsumer
		subtopic : String Предоставляет доступ к подтеме для удаленного адресата, используемого MessageAgent.	Consumer
		timestamp : Number Содержит временную метку последнего сообщения, полученного этим получателем.	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 Обрабатывает ChannelEvent CONNECT.	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void Обрабатывает ChannelEvent DISCONNECT.	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void Обрабатывает ChannelFaultEvent.	MessageAgent
		disconnect():void [переопределить] Отключает получатель от его удаленного адресата.	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 Запрашивает любые сообщения, которые поставлены в очередь для этого получателя на сервере.	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 Используется для автоматической инициализации свойства channelSet для MessageAgent перед первым подключением.	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void Отправляет сообщение от MessageAgent его адресату с помощью ChannelSet агента.	MessageAgent
		reAuthorize(msg:IMessage):void Эта функция должна быть перезаписана подклассами для реализации повторной аутентификации вследствие специфичного для них поведения тайм-аута сеанса сервера.	MessageAgent

События

Дополнительные сведения о событиях

Скрыть унаследованные события

Показать унаследованные события

	Сводка	Определено
acknowledge	Передается при получении сообщения подтверждения для отправленного сообщения.	MessageAgent
activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным.	EventDispatcher
channelConnect	Передается при подключении основного канала, используемого MessageAgent.	MessageAgent
channelDisconnect	Передается при отключении основного канала, используемого MessageAgent.	MessageAgent
channelFault	Передается при ошибке основного канала, используемого MessageAgent.	MessageAgent
deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным.	EventDispatcher
fault	Передается при возникновении ошибки сообщения.	MessageAgent
message	Передается при получении сообщения получателем.	Consumer
propertyChange	Передается при изменении свойства connected 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

Селектор для получателя. Выражение, передаваемое адресату, использующему его для фильтрации доставляемых получателю сообщений.

До вызова метода subscribe() это свойство может быть установлено без побочных эффектов. После того как получатель будет подписан на адрес назначения, изменение этого значения имеет побочный эффект, который заключается в обновлении подписки получателя для немедленного использования нового селекторного выражения.

Удаленный адресат должен распознать значение селекторного выражения.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие 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.

Реализация
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") — Псевдоним для типа сообщения, обрабатываемого службой, которая размещает удаленного адресата, на который будет подписан получатель. Этот параметр устарел и игнорируется конструктором.

Пример ( Использование этого примера )

       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

Передается при получении сообщения получателем.

Тип события MESSAGE; обрабатывается по получении сообщения.

Значением этой константы является message.

Свойства объекта события имеют следующие значения:

Свойство	Значение
`bubbles`	false
`cancelable`	false
`currentTarget`	Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется `myButton.addEventListener()` для регистрации прослушивателя события, значением `currentTarget` является myButton.
`message`	Сообщение, связанное с этим событием.
`target`	Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство `currentTarget` всегда используется для получения доступа к объекту, прослушивающему событие.

Юридическая информация | Политика конфиденциальности онлайн

Consumer - AS3 BlazeDS LCDS

Классы x

selector

subtopic

Consumer

message