Пакет | mx.messaging |
Класс | public class ChannelSet |
Наследование | ChannelSet ![]() ![]() |
Подклассы | AdvancedChannelSet |
Язык версии: | ActionScript 3.0 |
Версии продуктов: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Свойство MXML по умолчаниюchannels
Свойство | Определено | ||
---|---|---|---|
connected : Boolean [только для чтения]
Указывает, подключен ли ChannelSet. | ChannelSet | ||
![]() | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
heartbeatInterval : int
Количество миллисекунд между периодическими контрольными сообщениями, отправляемыми удаленному узлу, если подключение к этому ChannelSet активно и свободно. | ChannelSet |
Метод | Определено | ||
---|---|---|---|
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
![]() |
Посылает событие в поток событий. | EventDispatcher | |
![]() |
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
![]() |
Показывает, определено ли заданное свойство для объекта. | Object | |
![]() |
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
Отключает ChannelSet от сервера. | ChannelSet | ||
![]() |
Показывает наличие заданного свойства и его перечисляемость. | Object | |
![]() |
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
![]() |
Задает доступность динамического свойства для операций цикла. | Object | |
![]() |
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
![]() |
Возвращает элементарное значение заданного объекта. | Object | |
![]() |
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher |
Метод | Определено | ||
---|---|---|---|
Повторно передает события сообщений из подключенного в настоящее время канала. | ChannelSet |
Событие | Сводка | Определено | ||
---|---|---|---|---|
![]() | [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным. | EventDispatcher | ||
![]() | [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным. | EventDispatcher |
connected | свойство |
heartbeatInterval | свойство |
heartbeatInterval:int
Количество миллисекунд между периодическими контрольными сообщениями, отправляемыми удаленному узлу, если подключение к этому ChannelSet активно и свободно. Любые исходящие сообщения приводят к задержке перед отправкой следующего периодического контрольного сообщения на данное количество миллисекунд после последнего переданного сообщения.
Это свойство необходимо для приложений, которые соединяются с удаленным хостом для получения помещенных обновлений и не передают активно каких-либо сообщений, но для которых требуются уведомления о разрыве подключения даже в том случае, если сетевой уровень не предоставляет такое уведомление непосредственно. Путем отправки периодических контрольных сообщений клиент может вызвать принудительное сообщение сетевого уровня о тайм-ауте, если основное подключение было разорвано без уведомления. Таким образом, приложение может ответить на отключение соответствующим образом.
Любое неположительное значение отключает отправку контрольных сообщений к удаленному узлу. Значение по умолчанию 0. Оно указывает, что отправка контрольных сообщений отключена. При установке значения приложением использование более длинного интервала позволяет избежать ненужной нагрузки на удаленный хост. Например, по умолчанию проверки активности TCP-сокета нижнего уровня, как правило, имеют интервал 2 часа. Этот интервал длиннее необходимого для большинства приложений с активной отправкой контрольных сообщений, но это наглядный пример того, что необходимо использовать более длинный интервал.
Если подключенные в настоящее время основные команды опросы канала обращаются к удаленному узлу, отправка контрольных сообщений отключается, поскольку выполняются периодические команды опроса.
Реализация
public function get heartbeatInterval():int
public function set heartbeatInterval(value:int):void
logout | () | метод |
public function logout(agent:MessageAgent = null):mx.rpc:AsyncToken
Отключает ChannelSet от сервера. В отличие от других операций на каналах и ChannelSet, эта операция возвращает AsyncToken, к которому код клиента может добавить ответчик для прямой обработки успешного или ошибочного выполнения. При успешном выходе из системы все учетные данные, кэшированные для использования в автоматических повторных подключениях, сбрасываются для ChannelSet и его каналов, и для их аутентифицируемого состояния устанавливается значение false. Если ChannelSet не подключен к серверу при вызове этого метода, то он запустит попытку подключения, и в случае успеха отправит на сервер команду выхода из системы.
Аргумент MessageAgent присутствует для поддержки устаревшего поведения при выходе из системы, и код клиента, вызывающий этот метод, не должен передавать ссылку MessageAgent. Достаточно вызвать logout()
, не передающий аргументов.
Этот метод также вызывается компонентами услуги из их методов logout()
, и эти компоненты передают ссылку MessageAgent в этот метод при их выходе из системы. Присутствие этого аргумента является сигналом запуска для выполнения устаревшего поведения при выходе из системы, которое отличается от описанного выше нового поведения. Устаревшее поведение только отправляет запрос выхода из системы на сервер, если клиент подключен и аутентифицирован. При невыполнении этих условий устаревшим поведением для этого метода является только сброс всех учетных значений, кэшированных для использования в автоматических повторных подключениях.
Параметры
agent:MessageAgent (default = null ) — Устаревший аргумент. MessageAgent, инициирующий выход из системы.
|
mx.rpc:AsyncToken — Возвращает маркер, к которому код клиента может добавить ответчик для прямой обработки успешного или ошибочного выполнения.
|
Выдает
IllegalOperationError — Если в настоящее время происходит операция входа в систему или выхода из системы.
|
messageHandler | () | метод |
protected function messageHandler(event:MessageEvent):void
Повторно передает события сообщений из подключенного в настоящее время канала.
Параметры
event:MessageEvent — MessageEvent из канала.
|
Tue Jun 12 2018, 11:34 AM Z