(仅限 BlazeDS)
mx.messaging.messages
public class CommandMessage
继承CommandMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object

CommandMessage 类可提供用于将命令发送至服务器基础结构(如与发布/订阅消息传送方案、ping 操作和群集操作相关的命令)的机制。



公共属性
 属性定义方
 Inheritedbody : Object
消息正文包含需要传递到远程目标的特定数据。
AbstractMessage
 InheritedclientId : String
ClientId 指示发送消息的 MessageAgent。
AbstractMessage
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
 InheritedcorrelationId : String
提供对此消息的相关 ID 的访问权限。
AsyncMessage
 Inheriteddestination : String
消息目标。
AbstractMessage
 Inheritedheaders : Object
消息标头是一个关联数组,其中关键字为标头名称,而值为标头值。
AbstractMessage
 InheritedmessageId : String
消息的唯一 ID。
AbstractMessage
  operation : uint
提供对 CommandMessage 的操作/命令的访问权限。
CommandMessage
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
 Inheritedtimestamp : Number
提供对消息时间戳的访问权限。
AbstractMessage
 InheritedtimeToLive : Number
消息的生存时间值指示该消息应视为有效且可传送的时间。
AbstractMessage
公共方法
 方法定义方
  
构造正文和标头为空,默认操作为 UNKNOWN_OPERATION 的 CommandMessage 实例。
CommandMessage
  
[静态] 提供对指定操作的描述。
CommandMessage
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
设置循环操作动态属性的可用性。
Object
  
返回消息的字符串表示形式。
CommandMessage
 Inherited
返回指定对象的原始值。
Object
公共常量
 常量定义方
  ADD_SUBSCRIPTIONS : String = "DSAddSub"
[静态] MULTI_SUBSCRIBE 消息中使用的标头,用于指定要添加到现有的一组 subscriptions 的 子主题/选择器对数组。
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
 InheritedDESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId"
[静态] 从服务器发出的消息可能按批到达,批处理过程中可能会将这些消息发送给不同的 Consumer 实例。
AbstractMessage
  DISCONNECT_OPERATION : uint = 12
[静态] 此操作用于指示通道已断开。
CommandMessage
 InheritedENDPOINT_HEADER : String = "DSEndpoint"
[静态] 消息将以所用发送 Channel 的端点 ID 作为标签。
AbstractMessage
 InheritedFLEX_CLIENT_ID_HEADER : String = "DSId"
[静态] 服务器指定标头后,可通过该标头在出站消息中传输全局 FlexClient Id 值。
AbstractMessage
  LOGIN_OPERATION : uint = 8
[静态] 此操作用于向端点发送凭据,以便用户可通过当前通道登录。
CommandMessage
  LOGOUT_OPERATION : uint = 9
[静态] 此操作用于将用户从当前通道中注销;如果该通道基于 HTTP,则会使服务器会话失效。
CommandMessage
  MESSAGING_VERSION : String = "DSMessagingVersion"
[静态] 通过在进行初始 ping CommandMessage 的握手期间报告所能够支持的最新消息传送版本,端点可指示它们支持的功能。
CommandMessage
  MULTI_SUBSCRIBE_OPERATION : uint = 11
[静态] 供 MultiTopicConsumer 用于在同一消息中订阅或取消订阅同一消息中的多个主题。
CommandMessage
  NEEDS_CONFIG_HEADER : String = "DSNeedsConfig"
[静态] 指示 Channel 需要服务器中配置的标头。
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 subscriptions。
CommandMessage
 InheritedREMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset"
[静态] 需要为目标设置远程凭据的消息还需要报告使用此标头创建凭据 String 时所用的字符集编码。
AbstractMessage
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[静态] 需要为目标设置远程凭据的消息采用此标头中的 Base64 编码凭据。
AbstractMessage
  REMOVE_SUBSCRIPTIONS : String = "DSRemSub"
[静态] 如上所述,但指定要删除的子主题/选择器数组
CommandMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[静态] 随定义的请求超时发送的消息将用到此标头。
AbstractMessage
  SELECTOR_HEADER : String = "DSSelector"
[静态] Consumer 发出的订阅命令在此标头中传递 Consumer 的选择器表达式。
CommandMessage
 InheritedSTATUS_CODE_HEADER : String = "DSStatusCode"
[静态] 一种状态代码,可以提供有关响应消息性质的上下文。
AbstractMessage
  SUBSCRIBE_OPERATION : uint = 0
[静态] 此操作用于订阅远程目标。
CommandMessage
  SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10
[静态] 此操作用于指示客户端的远程目标订阅已超时。
CommandMessage
 InheritedSUBTOPIC_HEADER : String = "DSSubtopic"
[静态] 由 MessageAgent(已定义 subtopic 属性)发送的消息会在此标头中指示其目标 subtopic。
AsyncMessage
  SUBTOPIC_SEPARATOR : String = "_;_"
[静态] 在添加和删除订阅标头过程中用于分隔 subtopic 和 selector 的分隔符字符串。
CommandMessage
  TRIGGER_CONNECT_OPERATION : uint = 13
[静态] 此操作用于触发要连接的 ChannelSet。
CommandMessage
  UNKNOWN_OPERATION : uint = 10000
[静态] 这是新 CommandMessage 实例的默认操作。
CommandMessage
  UNSUBSCRIBE_OPERATION : uint = 1
[静态] 此操作用于从远程目标取消订阅。
CommandMessage
属性详细信息
operation属性
public var operation:uint

提供对 CommandMessage 的操作/命令的访问权限。Operation 指示远程目标如何处理此消息。

构造函数详细信息
CommandMessage()构造函数
public function CommandMessage()

构造正文和标头为空,默认 operationUNKNOWN_OPERATION 的 CommandMessage 实例。

方法详细信息
getOperationAsString()方法
public static function getOperationAsString(op:uint):String

提供对指定操作的描述。使用此方法对该消息进行 toString() 操作。

参数

op:uint — CommandMessage 操作常数之一。

返回
String — 操作的短名称。

示例
如何使用示例
var msg:CommandMessage = CommandMessage(event.message);
         trace("Current operation -'"+
                CommandMessage.getOperationAsString(msg.operation)+ "'.");
toString()方法 
override public function toString():String

返回消息的字符串表示形式。

返回
String — 消息的字符串表示形式。
常量详细信息
ADD_SUBSCRIPTIONS常量
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"

MULTI_SUBSCRIBE 消息中使用的标头,用于指定要添加到现有的一组 subscriptions 的 子主题/选择器对数组。

AUTHENTICATION_MESSAGE_REF_TYPE常量 
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"

身份验证命令的服务器消息类型。

CLIENT_PING_OPERATION常量 
public static const CLIENT_PING_OPERATION:uint = 5

此操作用于测试通过当前通道到远程端点的连接性。

CLIENT_SYNC_OPERATION常量 
public static const CLIENT_SYNC_OPERATION:uint = 4

在客户端发出轮询命令后,远程目标通过此操作将漏掉或缓存的消息同步回客户端。

CLUSTER_REQUEST_OPERATION常量 
public static const CLUSTER_REQUEST_OPERATION:uint = 7

此操作用于根据群集成员身份请求远程目标故障转移端点的 URI 列表。

CREDENTIALS_CHARSET_HEADER常量 
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"

指定对登录凭据进行编码时所使用的字符集编码的标头。

DISCONNECT_OPERATION常量 
public static const DISCONNECT_OPERATION:uint = 12

此操作用于指示通道已断开。

LOGIN_OPERATION常量 
public static const LOGIN_OPERATION:uint = 8

此操作用于向端点发送凭据,以便用户可通过当前通道登录。凭据需要为 Base64 编码格式并存储在消息的 body 中。

LOGOUT_OPERATION常量 
public static const LOGOUT_OPERATION:uint = 9

此操作用于将用户从当前通道中注销;如果该通道基于 HTTP,则会使服务器会话失效。

MESSAGING_VERSION常量 
public static const MESSAGING_VERSION:String = "DSMessagingVersion"

通过在进行初始 ping CommandMessage 的握手期间报告所能够支持的最新消息传送版本,端点可指示它们支持的功能。

MULTI_SUBSCRIBE_OPERATION常量 
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11

供 MultiTopicConsumer 用于在同一消息中订阅或取消订阅同一消息中的多个主题。

NEEDS_CONFIG_HEADER常量 
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"

指示 Channel 需要服务器中配置的标头。

NO_OP_POLL_HEADER常量 
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"

禁止处理轮询响应的标头。如果客户端已经向服务器提交了一个长轮询并发出了另一个轮询,则应使用此标头作为该后续轮询响应的标签:在此情况下,会将该响应视为 no-op(无操作),且不会调度下一个轮询。如果没有此标头,后续的轮询会将通道和端点置于繁忙的轮询循环中。

POLL_OPERATION常量 
public static const POLL_OPERATION:uint = 2

此操作用于轮询未处理、未传递的消息的远程目标。

POLL_WAIT_HEADER常量 
public static const POLL_WAIT_HEADER:String = "DSPollWait"

强迫在请求下一次客户端轮询前需经历空闲等待时间的标头。

PRESERVE_DURABLE_HEADER常量 
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"

当取消订阅消息在标头中将此参数设置为 true 时,将保留持久的 JMS subscriptions。

REMOVE_SUBSCRIPTIONS常量 
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"

如上所述,但指定要删除的子主题/选择器数组

SELECTOR_HEADER常量 
public static const SELECTOR_HEADER:String = "DSSelector"

Consumer 发出的订阅命令在此标头中传递 Consumer 的 selector 表达式。

SUBSCRIBE_OPERATION常量 
public static const SUBSCRIBE_OPERATION:uint = 0

此操作用于订阅远程目标。

SUBSCRIPTION_INVALIDATE_OPERATION常量 
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10

此操作用于指示客户端的远程目标订阅已超时。

SUBTOPIC_SEPARATOR常量 
public static const SUBTOPIC_SEPARATOR:String = "_;_"

在添加和删除订阅标头过程中用于分隔 subtopic 和 selector 的分隔符字符串。

TRIGGER_CONNECT_OPERATION常量 
public static const TRIGGER_CONNECT_OPERATION:uint = 13

此操作用于触发要连接的 ChannelSet。

UNKNOWN_OPERATION常量 
public static const UNKNOWN_OPERATION:uint = 10000

这是新 CommandMessage 实例的默认操作。

UNSUBSCRIBE_OPERATION常量 
public static const UNSUBSCRIBE_OPERATION:uint = 1

此操作用于从远程目标取消订阅。