Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
mx.messaging.messages 

CommandMessage  - AS3 BlazeDS LCDS

Пакетmx.messaging.messages
Классpublic class CommandMessage
НаследованиеCommandMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Класс CommandMessage предоставляет механизм отправки команд в инфраструктуру сервера, например команд, имеющих отношение к сценариям передачи сообщений о публикациях/подписке, к операциям ping и кластерным операциям.



Общедоступные свойства
 СвойствоОпределено
 Inheritedbody : Object
Текст сообщения содержит определенные данные, которые должны быть доставлены удаленному адресату.
AbstractMessage
 InheritedclientId : String
clientId указывает MessageAgent, передавший сообщение.
AbstractMessage
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcorrelationId : String
Предоставляет доступ к идентификатору корреляции сообщения.
AsyncMessage
 Inheriteddestination : String
Адрес назначения сообщения.
AbstractMessage
 Inheritedheaders : Object
Заголовки сообщения представляют собой ассоциативный массив, ключом которого является имя заголовка, а значением – значение заголовка.
AbstractMessage
 InheritedmessageId : String
Уникальный идентификатор сообщения.
AbstractMessage
  operation : uint
Предоставляет доступ к операции/команде для CommandMessage.
CommandMessage
 Inheritedtimestamp : Number
Предоставляет доступ к временной метке сообщения.
AbstractMessage
 InheritedtimeToLive : Number
Значение времени действия сообщения указывает, как долго сообщение считается действительным и подлежащим доставке.
AbstractMessage
Общедоступные методы
 МетодОпределено
  
Создает экземпляр CommandMessage с пустым телом и заголовком, а также операцией по умолчанию UNKNOWN_OPERATION.
CommandMessage
  
[статические] Предоставляет описание указанной операции.
CommandMessage
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
  
[переопределить] Возвращает представление сообщения в виде строки.
CommandMessage
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Общедоступные константы
 КонстантаОпределено
  ADD_SUBSCRIPTIONS : String = "DSAddSub"
[статические] Заголовок, используемый в сообщении MULTI_SUBSCRIBE для указания массива пар «подтема – селектор», добавляемого к существующему набору подписок.
CommandMessage
  AUTHENTICATION_MESSAGE_REF_TYPE : String = "flex.messaging.messages.AuthenticationMessage"
[статические] Тип сообщений сервера для команд аутентификации.
CommandMessage
  CLIENT_PING_OPERATION : uint = 5
[статические] Эта операция используется для тестирования возможности соединения с удаленной конечной точкой через текущий канал.
CommandMessage
  CLIENT_SYNC_OPERATION : uint = 4
[статические] Эта операция используется удаленным адресатом для синхронизации с клиентом пропущенных или кэшированных сообщений в результате выданной клиентом команды опроса.
CommandMessage
  CLUSTER_REQUEST_OPERATION : uint = 7
[статические] Эта операция используется для запроса списка URI конечных точек преодоления отказа удаленного адресата на основе элементов кластера.
CommandMessage
  CREDENTIALS_CHARSET_HEADER : String = "DSCredentialsCharset"
[статические] Заголовок для указания кодировки набора символов, использованной при кодировании учетных данных входа в систему.
CommandMessage
  DISCONNECT_OPERATION : uint = 12
[статические] Эта операция используется для указания на отключение канала.
CommandMessage
  HEARTBEAT_HEADER : String = "DS<3"
[статические] Заголовок, указывающий на то, что сообщение является периодическим сигналом.
CommandMessage
  LOGIN_OPERATION : uint = 8
[статические] Эта операция используется для отправки учетных данных в конечную точку, что позволяет пользователю зарегистрироваться посредством текущего канала.
CommandMessage
  LOGOUT_OPERATION : uint = 9
[статические] Эта операция используется для регистрации пользователя вне текущего канала и аннулирования сеанса сервера, если канал функционирует на основе HTTP.
CommandMessage
  MAX_FREQUENCY_HEADER : String = "DSMaxFrequency"
[статические] Заголовок для указания максимального количества сообщений, принимаемых получателем в секунду.
CommandMessage
  MESSAGING_VERSION : String = "DSMessagingVersion"
[статические] Во время квитирования установления связи с использованием исходной операции ping CommandMessage конечные точки могут неявно указать поддерживаемые ими функции, предоставляя последнюю версию процесса передачи сообщений.
CommandMessage
  MULTI_SUBSCRIBE_OPERATION : uint = 11
[статические] Используется в MultiTopicConsumer для подписки/отмены подписки на несколько тем в одном сообщении.
CommandMessage
  NEEDS_CONFIG_HEADER : String = "DSNeedsConfig"
[статические] Заголовок, указывающий, что канал нуждается в конфигурировании со стороны сервера.
CommandMessage
  NO_OP_POLL_HEADER : String = "DSNoOpPoll"
[статические] Заголовок для подавления обработки ответа на опрос.
CommandMessage
  POLL_OPERATION : uint = 2
[статические] Эта операция используется для получения информации с удаленного адреса назначения о задержанных, не доставленных сообщениях.
CommandMessage
  POLL_WAIT_HEADER : String = "DSPollWait"
[статические] Заголовок для управления временем ожидания перед запуском команды опроса на следующем клиенте.
CommandMessage
  PRESERVE_DURABLE_HEADER : String = "DSPreserveDurable"
[статические] Если в заголовке сообщения об отмене подписки этот параметр установлен в true, то длительные подписки JMS сохраняются.
CommandMessage
  REMOVE_SUBSCRIPTIONS : String = "DSRemSub"
[статические] Аналогичен предыдущему, но указывает массив подтемы/селектора, который следует удалить
CommandMessage
  SELECTOR_HEADER : String = "DSSelector"
[статические] Используемые получателем команды подписки передают в заголовке выражение получателя selector.
CommandMessage
  SUBSCRIBE_OPERATION : uint = 0
[статические] Эта операция используется для подписки на удаленный адрес.
CommandMessage
  SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10
[статические] Эта операция используется для указания на завершение срока подписки клиента с удаленным адресатом.
CommandMessage
  SUBTOPIC_SEPARATOR : String = "_;_"
[статические] Строка разделителя, используемая для разделения подтемы и селекторов в заголовках добавления и удаления подписки.
CommandMessage
  TRIGGER_CONNECT_OPERATION : uint = 13
[статические] Эта операция используется для запуска подключения ChannelSet.
CommandMessage
  UNKNOWN_OPERATION : uint = 10000
[статические] Операция по умолчанию для новых экземпляров CommandMessage.
CommandMessage
  UNSUBSCRIBE_OPERATION : uint = 1
[статические] Эта операция используется для отмены подписки с удаленного адреса.
CommandMessage
Сведения о свойстве

operation

свойство
public var operation:uint

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Предоставляет доступ к операции/команде для CommandMessage. Операции указывают способ обработки сообщения удаленным адресатом.

Сведения о конструкторе

CommandMessage

()Конструктор
public function CommandMessage()

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Создает экземпляр CommandMessage с пустым телом и заголовком, а также операцией по умолчанию UNKNOWN_OPERATION.

Сведения о методе

getOperationAsString

()метод
public static function getOperationAsString(op:uint):String

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Предоставляет описание указанной операции. Этот метод используется в операциях toString() данного сообщения.

Параметры

op:uint — Одна из констант операции CommandMessage.

Возвращает
String — Краткое имя операции.

Пример
Использование этого примера
         var msg:CommandMessage = CommandMessage(event.message);
         trace("Current operation -'"+
                CommandMessage.getOperationAsString(msg.operation)+ "'.");
      

toString

()метод 
override public function toString():String

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Возвращает представление сообщения в виде строки.

Возвращает
String — Представление сообщения в виде строки.
Сведения о константе

ADD_SUBSCRIPTIONS

Константа
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Заголовок, используемый в сообщении MULTI_SUBSCRIBE для указания массива пар «подтема – селектор», добавляемого к существующему набору подписок.

AUTHENTICATION_MESSAGE_REF_TYPE

Константа 
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Тип сообщений сервера для команд аутентификации.

CLIENT_PING_OPERATION

Константа 
public static const CLIENT_PING_OPERATION:uint = 5

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для тестирования возможности соединения с удаленной конечной точкой через текущий канал.

CLIENT_SYNC_OPERATION

Константа 
public static const CLIENT_SYNC_OPERATION:uint = 4

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется удаленным адресатом для синхронизации с клиентом пропущенных или кэшированных сообщений в результате выданной клиентом команды опроса.

CLUSTER_REQUEST_OPERATION

Константа 
public static const CLUSTER_REQUEST_OPERATION:uint = 7

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для запроса списка URI конечных точек преодоления отказа удаленного адресата на основе элементов кластера.

CREDENTIALS_CHARSET_HEADER

Константа 
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

DISCONNECT_OPERATION

Константа 
public static const DISCONNECT_OPERATION:uint = 12

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для указания на отключение канала.

HEARTBEAT_HEADER

Константа 
public static const HEARTBEAT_HEADER:String = "DS<3"

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

LOGIN_OPERATION

Константа 
public static const LOGIN_OPERATION:uint = 8

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для отправки учетных данных в конечную точку, что позволяет пользователю зарегистрироваться посредством текущего канала. Учетные данные должны быть представлены в кодировке Base64 и сохранены в body сообщения.

LOGOUT_OPERATION

Константа 
public static const LOGOUT_OPERATION:uint = 9

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для регистрации пользователя вне текущего канала и аннулирования сеанса сервера, если канал функционирует на основе HTTP.

MAX_FREQUENCY_HEADER

Константа 
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

MESSAGING_VERSION

Константа 
public static const MESSAGING_VERSION:String = "DSMessagingVersion"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

MULTI_SUBSCRIBE_OPERATION

Константа 
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Используется в MultiTopicConsumer для подписки/отмены подписки на несколько тем в одном сообщении.

NEEDS_CONFIG_HEADER

Константа 
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Заголовок, указывающий, что канал нуждается в конфигурировании со стороны сервера.

NO_OP_POLL_HEADER

Константа 
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

POLL_OPERATION

Константа 
public static const POLL_OPERATION:uint = 2

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

POLL_WAIT_HEADER

Константа 
public static const POLL_WAIT_HEADER:String = "DSPollWait"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Заголовок для управления временем ожидания перед запуском команды опроса на следующем клиенте.

PRESERVE_DURABLE_HEADER

Константа 
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Если в заголовке сообщения об отмене подписки этот параметр установлен в true, то длительные подписки JMS сохраняются.

REMOVE_SUBSCRIPTIONS

Константа 
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Аналогичен предыдущему, но указывает массив подтемы/селектора, который следует удалить

SELECTOR_HEADER

Константа 
public static const SELECTOR_HEADER:String = "DSSelector"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Используемые получателем команды подписки передают в заголовке выражение получателя selector.

SUBSCRIBE_OPERATION

Константа 
public static const SUBSCRIBE_OPERATION:uint = 0

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для подписки на удаленный адрес.

SUBSCRIPTION_INVALIDATE_OPERATION

Константа 
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для указания на завершение срока подписки клиента с удаленным адресатом.

SUBTOPIC_SEPARATOR

Константа 
public static const SUBTOPIC_SEPARATOR:String = "_;_"

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Строка разделителя, используемая для разделения подтемы и селекторов в заголовках добавления и удаления подписки.

TRIGGER_CONNECT_OPERATION

Константа 
public static const TRIGGER_CONNECT_OPERATION:uint = 13

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для запуска подключения ChannelSet.

UNKNOWN_OPERATION

Константа 
public static const UNKNOWN_OPERATION:uint = 10000

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Операция по умолчанию для новых экземпляров CommandMessage.

UNSUBSCRIBE_OPERATION

Константа 
public static const UNSUBSCRIBE_OPERATION:uint = 1

Язык версии: ActionScript 3.0
Версии продуктов: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Эта операция используется для отмены подписки с удаленного адреса.





[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.