(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
パブリックメソッド
 メソッド定義元
  
本文とヘッダーが空で、デフォルトの operation として UNKNOWN_OPERATION が設定された CommandMessage インスタンスを作成します。
CommandMessage
  
[静的] 指定した操作の説明を設定します。
CommandMessage
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
[override] メッセージのストリング表現を返します。
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
 InheritedDESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId"
[静的] サーバーからプッシュされたメッセージがバッチとして到着したとき、そのバッチ内のメッセージが複数の異なるコンシューマインスタンスをターゲットにしている可能性があります。
AbstractMessage
  DISCONNECT_OPERATION : uint = 12
[静的] この操作は、チャンネルが切断されたことを示すために使用されます。
CommandMessage
 InheritedENDPOINT_HEADER : String = "DSEndpoint"
[静的] メッセージには、メッセージが送信されるチャンネルのエンドポイント ID のタグが付与されます。
AbstractMessage
 InheritedFLEX_CLIENT_ID_HEADER : String = "DSId"
[静的] サーバーによってグローバル FlexClient の ID 値が出力メッセージに割り当てられると、このヘッダーはその値の伝達に使用されます。
AbstractMessage
  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
 InheritedPRIORITY_HEADER : String = "DSPriority"
[静的] MessageAgent が送信するメッセージには数値が 0 ~ 9(0 が最小)の優先度ヘッダーがある場合があります。サーバーはこの数値を使用して、クライアントへのメッセージに優先度を設定できます。
AbstractMessage
 InheritedREMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset"
[静的] 宛先のリモート証明書を設定する必要があるメッセージは、このヘッダを使用して、資格情報ストリングの作成に使用された文字セットエンコーディングも報告する必要があります。
AbstractMessage
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[静的] 宛先のリモート証明書を設定する必要があるメッセージは、このヘッダー内に Base64 エンコードされた資格情報を保持します。
AbstractMessage
  REMOVE_SUBSCRIPTIONS : String = "DSRemSub"
[静的] 上記と同様。ただし、削除するサブトピックとセレクタの配列を指定します。
CommandMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[静的] このヘッダーは、要求タイムアウトを定義して送信されるメッセージに使用されます。
AbstractMessage
  SELECTOR_HEADER : String = "DSSelector"
[静的] コンシューマによって発行されたサブスクライブコマンドでは、このヘッダでコンシューマの selector 式を渡します。
CommandMessage
 InheritedSTATUS_CODE_HEADER : String = "DSStatusCode"
[静的] ステータスコードは、応答メッセージの特徴に関するコンテキストを提供できます。
AbstractMessage
  SUBSCRIBE_OPERATION : uint = 0
[静的] この操作は、リモート宛先にサブスクライブするために使用されます。
CommandMessage
  SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10
[静的] この操作は、リモート宛先によるクライアントのサブスクリプションがタイムアウトしたことを示すために使用されます。
CommandMessage
 InheritedSUBTOPIC_HEADER : String = "DSSubtopic"
[静的] subtopic プロパティが定義された MessageAgent から送信されたメッセージでは、メッセージのターゲットとなるサブトピックがこのヘッダ内に示されます。
AsyncMessage
  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

CommandMessage の操作またはコマンドへのアクセスを提供します。 操作は、リモート宛先でこのメッセージを処理する方法を示します。

コンストラクタの詳細
CommandMessage()コンストラクタ
public function CommandMessage()

本文とヘッダーが空で、デフォルトの operation として UNKNOWN_OPERATION が設定された CommandMessage インスタンスを作成します。

メソッドの詳細
getOperationAsString()メソッド
public static function getOperationAsString(op:uint):String

指定した操作の説明を設定します。 このメソッドは、このメッセージに対する toString() 操作で使用されます。

パラメータ

op:uint — CommandMessage 操作の定数の 1 つです。

戻り値
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 メッセージ内で使用されるヘッダーです。

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 ベースの場合にサーバーセッションを無効にします。

MAX_FREQUENCY_HEADER定数 
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"

コンシューマが毎秒希望する最大メッセージ数を示します。

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"

サーバーからの設定がチャンネルに必要であることを示すヘッダーです。

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 サブスクリプションは維持されます。

REMOVE_SUBSCRIPTIONS定数 
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"

上記と同様。ただし、削除するサブトピックとセレクタの配列を指定します。

SELECTOR_HEADER定数 
public static const SELECTOR_HEADER:String = "DSSelector"

コンシューマによって発行されたサブスクライブコマンドでは、このヘッダでコンシューマの 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 = "_;_"

サブスクリプションヘッダーの追加または削除の際に、サブトピックとセレクタを区切るのに使用される区切り文字です。

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

この操作は、リモート宛先からのサブスクライブ解除に使用します。





 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/messaging/messages/CommandMessage.html