包 | mx.messaging.messages |
类 | public class AbstractMessage |
继承 | AbstractMessage Object |
实现 | IMessage |
子类 | AsyncMessage, HTTPRequestMessage, RemotingMessage |
headers
属性可访问特定消息实例的专门元信息。headers
属性是以特定标头名称作为关键字的关联数组。
消息正文包含需要由远程目标传递和处理的特定实例数据。body
是作为消息有效负载的对象。
属性 | 定义方 | ||
---|---|---|---|
body : Object 消息正文包含需要传递到远程目标的特定数据。 | AbstractMessage | ||
clientId : String ClientId 指示发送消息的 MessageAgent。 | AbstractMessage | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
destination : String 消息目标。 | AbstractMessage | ||
headers : Object 消息标头是一个关联数组,其中关键字为标头名称,而值为标头值。 | AbstractMessage | ||
messageId : String 消息的唯一 ID。 | AbstractMessage | ||
prototype : Object [静态]
对类或函数对象的原型对象的引用。 | Object | ||
timestamp : Number 提供对消息时间戳的访问权限。 | AbstractMessage | ||
timeToLive : Number 消息的生存时间值指示该消息应视为有效且可传送的时间。 | AbstractMessage |
方法 | 定义方 | ||
---|---|---|---|
构造一个正文和标头为空的 AbstractMessage 实例。 | AbstractMessage | ||
指示对象是否已经定义了指定的属性。 | Object | ||
指示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
指示指定的属性是否存在、是否可枚举。 | Object | ||
设置循环操作动态属性的可用性。 | Object | ||
返回消息的字符串表示形式。 | AbstractMessage | ||
返回指定对象的原始值。 | Object |
常量 | 定义方 | ||
---|---|---|---|
DESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId" [静态] 从服务器发出的消息可能按批到达,批处理过程中可能会将这些消息发送给不同的 Consumer 实例。 | AbstractMessage | ||
ENDPOINT_HEADER : String = "DSEndpoint" [静态] 消息将以所用发送 Channel 的端点 ID 作为标签。 | AbstractMessage | ||
FLEX_CLIENT_ID_HEADER : String = "DSId" [静态] 服务器指定标头后,可通过该标头在出站消息中传输全局 FlexClient Id 值。 | AbstractMessage | ||
REMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset" [静态] 需要为目标设置远程凭据的消息还需要报告使用此标头创建凭据 String 时所用的字符集编码。 | AbstractMessage | ||
REMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials" [静态] 需要为目标设置远程凭据的消息采用此标头中的 Base64 编码凭据。 | AbstractMessage | ||
REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout" [静态] 随定义的请求超时发送的消息将用到此标头。 | AbstractMessage | ||
STATUS_CODE_HEADER : String = "DSStatusCode" [静态] 一种状态代码,可以提供有关响应消息性质的上下文。 | AbstractMessage |
body | 属性 |
body:Object
[读写] 消息正文包含需要传递到远程目标的特定数据。
public function get body():Object
public function set body(value:Object):void
clientId | 属性 |
clientId:String
[读写] ClientId 指示发送消息的 MessageAgent。
public function get clientId():String
public function set clientId(value:String):void
destination | 属性 |
destination:String
[读写] 消息目标。
public function get destination():String
public function set destination(value:String):void
headers | 属性 |
headers:Object
[读写] 消息标头是一个关联数组,其中关键字为标头名称,而值为标头值。通过此属性可访问特定消息实例的专门元信息。核心标头名称以“DS”前缀开头。自定义标头名称应该以唯一的前缀开头,以避免名称冲突。
public function get headers():Object
public function set headers(value:Object):void
messageId | 属性 |
messageId:String
[读写] 消息的唯一 ID。
public function get messageId():String
public function set messageId(value:String):void
timestamp | 属性 |
timestamp:Number
[读写] 提供对消息时间戳的访问权限。时间戳是发送消息的日期和时间。时间戳用于通过系统跟踪消息,以确保服务质量级别并提供消息期限机制。
public function get timestamp():Number
public function set timestamp(value:Number):void
另请参见
timeToLive | 属性 |
timeToLive:Number
[读写]
消息的生存时间值指示该消息应视为有效且可传送的时间。此值可与 timestamp
值配合使用。生存时间指消息从指定的 timestamp
值起保持有效的时间(以毫秒为单位)。例如,如果 timestamp
值为 04/05/05 1:30:45 PST,而 timeToLive
值为 5000,则此消息将于 04/05/05 1:30:50 PST 到期。一旦消息到期,便不会传递到其它任何客户端。
public function get timeToLive():Number
public function set timeToLive(value:Number):void
AbstractMessage | () | 构造函数 |
public function AbstractMessage()
构造一个正文和标头为空的 AbstractMessage 实例。不应直接实例化或使用此消息类型。
toString | () | 方法 |
DESTINATION_CLIENT_ID_HEADER | 常量 |
public static const DESTINATION_CLIENT_ID_HEADER:String = "DSDstClientId"
从服务器发出的消息可能按批到达,批处理过程中可能会将这些消息发送给不同的 Consumer 实例。每条消息都包含此标头,用以识别接收该消息的 Consumer 实例。
ENDPOINT_HEADER | 常量 |
public static const ENDPOINT_HEADER:String = "DSEndpoint"
消息将以所用发送 Channel 的端点 ID 作为标签。通道会在发送消息时自动设置此值。
FLEX_CLIENT_ID_HEADER | 常量 |
public static const FLEX_CLIENT_ID_HEADER:String = "DSId"
服务器指定标头后,可通过该标头在出站消息中传输全局 FlexClient Id 值。
REMOTE_CREDENTIALS_CHARSET_HEADER | 常量 |
public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = "DSRemoteCredentialsCharset"
需要为目标设置远程凭据的消息还需要报告使用此标头创建凭据 String 时所用的字符集编码。
REMOTE_CREDENTIALS_HEADER | 常量 |
public static const REMOTE_CREDENTIALS_HEADER:String = "DSRemoteCredentials"
需要为目标设置远程凭据的消息采用此标头中的 Base64 编码凭据。
REQUEST_TIMEOUT_HEADER | 常量 |
public static const REQUEST_TIMEOUT_HEADER:String = "DSRequestTimeout"
随定义的请求超时发送的消息将用到此标头。请求超时值在出站消息上通过服务或通道设置,此值可控制在请求超时前相应的 MessageResponder 等待消息确认、结果或错误响应所需的时间。
STATUS_CODE_HEADER | 常量 |
public static const STATUS_CODE_HEADER:String = "DSStatusCode"
一种状态代码,可以提供有关响应消息性质的上下文。例如,从基于 HTTP 的通道接收的消息可能需要报告 HTTP 响应状态代码(如果可用)。