パッケージ | mx.messaging.messages |
クラス | public class CommandMessage |
継承 | CommandMessage AsyncMessage AbstractMessage Object |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
プロパティ | 定義元 | ||
---|---|---|---|
body : Object
メッセージの本文には、リモート宛先に配信する必要がある特定のデータが含まれます。 | AbstractMessage | ||
clientId : String
clientId は、メッセージを送信した MessageAgent を示します。 | AbstractMessage | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
correlationId : String
メッセージの相関 ID へのアクセスを提供します。 | AsyncMessage | ||
destination : String
メッセージの宛先。 | AbstractMessage | ||
headers : Object
メッセージのヘッダーは、キーがヘッダー名、値がヘッダー値として格納される結合配列です。 | AbstractMessage | ||
messageId : String
メッセージ固有の ID。 | AbstractMessage | ||
operation : uint
CommandMessage の操作またはコマンドへのアクセスを提供します。 | CommandMessage | ||
timestamp : Number
メッセージの日時スタンプへのアクセスを提供します。 | AbstractMessage | ||
timeToLive : Number
メッセージの有効期間の値は、メッセージが有効で配信可能であると見なされる期間を示します。 | AbstractMessage |
メソッド | 定義元 | ||
---|---|---|---|
本文とヘッダーが空で、デフォルトの operation として UNKNOWN_OPERATION が設定された CommandMessage インスタンスを作成します。 | CommandMessage | ||
[静的]
指定した操作の説明を設定します。 | CommandMessage | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
[オーバーライド]
メッセージのストリング表現を返します。 | CommandMessage | ||
指定されたオブジェクトのプリミティブな値を返します。 | 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 |
本文とヘッダーが空で、デフォルトの operation
として UNKNOWN_OPERATION
が設定された CommandMessage インスタンスを作成します。
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 操作の定数の 1 つです。
|
String — 操作の短い名前です。
|
例
この例の使用方法
var msg:CommandMessage = CommandMessage(event.message);
trace("Current operation -'"+
CommandMessage.getOperationAsString(msg.operation)+ "'.");
toString | () | メソッド |
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 |
ポーリング応答の処理を抑制するためのヘッダーです。 サーバーに対するポーリングを長い間保留しているクライアントが別のポーリングを発行する場合、後者のポーリングに対する応答にはこのヘッダーをタグ付けする必要があります。その場合、この応答は no-op として扱われ、次のポーリングはスケジューリングされません。 これを行わないと、それ以降のポーリングによってチャンネルとエンドポイントはビジーポーリングのサイクルに入ります。
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 |
この操作は、リモート宛先からのサブスクライブ解除に使用します。
Tue Jun 12 2018, 10:34 AM Z