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

AbstractConsumer является базовым классом для классов Consumer и MultiTopicConsumer. Эти классы используются для получения инициированных сообщений с сервера.

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		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
		subscribed : Boolean [только для чтения] Указывает, подписан ли в настоящее время получатель.	AbstractConsumer
		timestamp : Number Содержит временную метку последнего сообщения, полученного этим получателем.	AbstractConsumer

Защищенные свойства

	Свойство		Определено
		_shouldBeSubscribed : Boolean Флаг, указывающий, должен ли этот получатель быть подписан или нет.	AbstractConsumer

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		AbstractConsumer() Создает получатель.	AbstractConsumer
		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	Передается при получении сообщения получателем.	AbstractConsumer
propertyChange	Передается при изменении свойства connected MessageAgent.	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

Флаг, указывающий, должен ли этот получатель быть подписан или нет.

maxFrequency

свойство

maxFrequency:uint

Язык версии:

ActionScript 3.0

Версии продуктов:

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

Версии среды выполнения:

Flash Player 9, AIR 1.1

Определяет максимальное количество сообщений в секунду, установленное получателем. Сервер, который распознает это значение, использует его как входные данные при определении скорости отправки сообщения получателю. Значением по умолчанию является 0 – это означает, что получатель не имеет предпочтений для скорости передачи сообщений. Следует отметить, что это свойство должно быть установлено до подписки получателя, и любые изменения после подписки получателя не будут иметь эффекта до тех пор, пока получатель не отменит подписку и не подпишется повторно.

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

Количество выполняемых получателем повторных попыток подписки при недоступном адресате или при ошибке подключения к адресату. При значении -1 возможно бесконечное количество попыток. Нулевое значение запрещает повторные попытки подписки.

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

Реализация
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void

Связанные элементы API

mx.messaging.Consumer.resubscribeInterval

resubscribeInterval

свойство

resubscribeInterval:int

Язык версии:

ActionScript 3.0

Версии продуктов:

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

Версии среды выполнения:

Flash Player 9, AIR 1.1

Количество миллисекунд между повторными попытками подписки. Если получатель не получает подтверждение для запроса подписки, то он будет ожидать указанное количество миллисекунд перед повторной попыткой подписки. Установка нулевого значения отключает повторные подписки.

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

Реализация
public function get resubscribeInterval():int
public function set resubscribeInterval(value:int):void

Выдает

ArgumentError — Если присвоенное значение отрицательное.

Связанные элементы API

mx.messaging.Consumer.resubscribeInterval

subscribed

свойство

subscribed:Boolean [только для чтения]

Язык версии:

ActionScript 3.0

Версии продуктов:

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

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает, подписан ли в настоящее время получатель. Событие 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

Содержит временную метку последнего сообщения, полученного этим получателем. Это значение передается адресату в вызове receive() для запроса о том, что он получает сообщения для получателя из временной метки передачи. Все сообщения со значением временной метки, которое больше значения timestamp, будут возвращены в течение операции опроса. Установка значения -1 приведет к извлечению всех кэшируемых сообщений из адресата.

Реализация
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

Создает получатель.

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

       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

Возвращает сообщение о подписке. Этот метод должен быть перезаписан подклассами, если они требуют пользовательские сообщения о подписке.

Возвращает

CommandMessage — 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

Возвращает сообщение об отмене подписки. Этот метод должен быть перезаписан подклассами, если им требуются пользовательские сообщения об отмене подписки.

Параметры

preserveDurable:Boolean — При значении true длительные подписки JMS не удаляются, позволяя получателям повторно подписываться и получать пропущенные сообщения позже.

Возвращает

CommandMessage — 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

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

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

Запрашивает любые сообщения, которые поставлены в очередь для этого получателя на сервере. Этот метод должен использоваться только для получателей, подписывающихся по неопрашиваемым каналам не в режиме реального времени. Этот метод является пустой командой, если получатель не подписан.

Параметры

timestamp:Number (default = 0) — Этот аргумент является устаревшим и игнорируется.

()

метод

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

Подписывается на удаленный адресат.

Параметры

clientId:String (default = null) — Идентификатор клиента для подписки. Используйте значение null для кратковременных получателей. Если подписка длительна, непротиворечивое значение должно быть обеспечено каждый раз, когда получатель подписывается для повторного подключения с правильной длительной подпиской в удаленном адресате.

Выдает

InvalidDestinationError — Если адрес назначения не установлен.

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

Отмена подписки на удаленный адресат. В случае длительных подписок JMS это удалит длительную подписку на сервере JMS.

Параметры

preserveDurable:Boolean (default = false) — При значении true длительные подписки JMS не удаляются, позволяя получателям повторно подписываться и получать пропущенные сообщения позже.

Сведения о событии

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` всегда используется для получения доступа к объекту, прослушивающему событие.

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

AbstractConsumer - AS3 BlazeDS LCDS

Классы x

_shouldBeSubscribed

maxFrequency

resubscribeAttempts

resubscribeInterval

subscribed

timestamp