mx.messaging.Consumer （Flex 3.2）

（BlazeDS のみ）

パッケージ	mx.messaging
クラス	public class Consumer
継承	Consumer AbstractConsumer MessageAgent EventDispatcher Object

コンシューマはメッセージを受信するために宛先にサブスクライブします。コンシューマがサブスクライブおよびアンサブスクライブのメッセージを送信すると、処理が成功したかどうかによって MessageAckEvent または MessageFaultEvent が生成されます。サブスクライブすると、コンシューマは受信した各メッセージについて MessageEvent を送出します。コンシューマはセレクタを使ってメッセージをフィルタする機能を提供します。このセレクタは、宛先で理解可能でなければなりません。

MXML のシンタックス expanded

MXML シンタックスを隠す

The <mx:Consumer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <mx:Consumer
    Properties
    resubscribeAttempts="5"
    resubscribeInterval="5000"
    selector="No default."
    timestamp="No default."
  />

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		authenticated : Boolean [読み取り専用] この MessageAgent が宛先への接続に認証を使用するかどうかを示します。	MessageAgent
		channelSet : ChannelSet MessageAgent が使用する ChannelSet へのアクセスを提供します。	MessageAgent
		clientId : String [読み取り専用] MessageAgent のクライアント ID へのアクセスを提供します。	MessageAgent
		connected : Boolean [読み取り専用] この MessageAgent が現在、ChannelSet を介して宛先に接続されているかどうかを示します。	MessageAgent
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		destination : String MessageAgent の宛先へのアクセスを提供します。	MessageAgent
		maxFrequency : uint コンシューマが毎秒受信を希望する最大メッセージ数を決定します。	AbstractConsumer
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		requestTimeout : int 送信メッセージの要求タイムアウト時間（秒単位）に対するアクセスを提供します。	MessageAgent
		resubscribeAttempts : int 宛先が利用できない場合、または宛先への接続が失敗した場合に、コンシューマが再サブスクライブを試行する回数です。	AbstractConsumer
		resubscribeInterval : int 再サブスクライブを試行する間隔（ミリ秒数）です。	AbstractConsumer
		selector : String コンシューマのセレクタです。	Consumer
		subscribed : Boolean [読み取り専用] コンシューマが現在サブスクライブされているかどうかを示します。	AbstractConsumer
		subtopic : String MessageAgent が使用するリモート宛先のサブトピックへのアクセスを提供します。	Consumer
		timestamp : Number このコンシューマが受信した最新のメッセージのタイムスタンプが含まれます。	AbstractConsumer

	プロパティ	定義元
		_shouldBeSubscribed : Boolean このコンシューマをサブスクライブするかどうかを示すフラグです。	AbstractConsumer

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") コンシューマを作成します。	Consumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void 送信されたメッセージの結果を受信したときに MessageResponder によって呼び出されます。	MessageAgent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		channelConnectHandler(event:ChannelEvent):void CONNECT ChannelEvent を処理します。	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void DISCONNECT ChannelEvent を処理します。	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void ChannelFaultEvent を処理します。	MessageAgent
		disconnect():void [override] コンシューマをリモート宛先から切断します。	AbstractConsumer
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void 送信されたメッセージの失敗を受信したときに、MessageResponder によって呼び出されます。	MessageAgent
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		hasPendingRequestForMessage(msg:IMessage):Boolean 渡されたメッセージに対し保留の要求がある場合、true を返します。	MessageAgent
		initialized(document:Object, id:String):void 実装オブジェクトが作成され、タグに指定されたすべてのプロパティが割り当てられた後に呼び出されます。	MessageAgent
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		logout():void MessageAgent をリモート宛先からログアウトします。	MessageAgent
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		receive(timestamp:Number = 0):void サーバー上のこのコンシューマに対してキューに置かれているメッセージを要求します。	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void MessageAgent が宛先の認証に使用する証明書を設定します。	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void セカンダリシステムへの認証のためにリモート宛先に渡すリモート資格情報を設定します。	MessageAgent
		subscribe(clientId:String = null):void リモート宛先にサブスクライブします。	AbstractConsumer
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		unsubscribe(preserveDurable:Boolean = false):void リモート宛先からサブスクライブ解除します。	AbstractConsumer
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

	メソッド	定義元
		buildSubscribeMessage():CommandMessage サブスクライブメッセージを返します。	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage アンサブスクライブメッセージを返します。	AbstractConsumer
		initChannelSet(message:IMessage):void MessageAgent の初回の接続前に MessageAgent の channelSet プロパティを自動的に初期化します。	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void エージェントの ChannelSet を使って、MessageAgent から宛先にメッセージを送信します。	MessageAgent
		reAuthorize(msg:IMessage):void この関数をサブクラスでオーバーライドして、サブクラス固有のサーバーセッションタイムアウト動作による再認証を実装する必要があります。	MessageAgent

イベント

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
acknowledge	送信したメッセージに対する応答メッセージを受信したときに送出されます。	MessageAgent
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
channelConnect	MessageAgent が使用中の基本チャンネルが接続されたときに送出されます。	MessageAgent
channelDisconnect	MessageAgent が使用中の基本チャンネルが切断されたときに送出されます。	MessageAgent
channelFault	MessageAgent が使用中の基本チャンネルでエラーが発生したときに送出されます。	MessageAgent
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
fault	メッセージエラーが発生したときに送出されます。	MessageAgent
message	コンシューマがメッセージを受信したときに送出されます。	Consumer
propertyChange	MessageAgent の connected プロパティが変更されたときに送出されます。	MessageAgent

プロパティの詳細

selector

プロパティ

selector:String

コンシューマのセレクタです。これは宛先に渡される式で、宛先はこれを使用してコンシューマに配信するメッセージをフィルタします。

subscribe() メソッドを呼び出す前に、このプロパティを副次的な影響を与えずに設定することができます。コンシューマが宛先にサブスクライブした後でこの値を変更すると、コンシューマのサブスクリプションが更新されて新しいセレクタの式がすぐに使用されるという副次的な影響が発生します。

リモート宛先がセレクタの式の値を理解できる必要があります。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 propertyChange イベントが送出されます。

実装
public function get selector():String
public function set selector(value:String):void

subtopic

プロパティ

subtopic:String

MessageAgent が使用するリモート宛先のサブトピックへのアクセスを提供します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 propertyChange イベントが送出されます。

実装
public function get subtopic():String
public function set subtopic(value:String):void

コンストラクタの詳細

Consumer

()

コンストラクタ

public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")

コンシューマを作成します。

パラメータ

messageType:String (default = "flex.messaging.messages.AsyncMessage") — コンシューマがサブスクライブするリモート宛先をホストしているサービスで処理されるメッセージタイプのエイリアスです。このパラメータは推奨されておらず、コンストラクタによって無視されます。

例

       function initConsumer():void
       {
           var consumer:Consumer = new Consumer();
           consumer.destination = "NASDAQ";
           consumer.selector = "operation IN ('Bid','Ask')";
           consumer.addEventListener(MessageEvent.MESSAGE, messageHandler);
           consumer.subscribe();
       }
            function messageHandler(event:MessageEvent):void
       {
           var msg:IMessage = event.message;
           var info:Object = msg.body;
           trace("-App recieved message: " + msg.toString());
       }

イベントの詳細

message

イベント

イベントオブジェクトの型: mx.messaging.events.MessageEvent
プロパティ MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

コンシューマがメッセージを受信したときに送出されます。

MESSAGE イベント型。メッセージの受信時に送出されます。

この定数の値は "message" です。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、`currentTarget` の値は myButton となります。
`message`	このイベントに関連付けられたメッセージです。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

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

Adobe® Flex™ 3.2 リファレンスガイド This Help system only	すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレームフレームなし
Consumer	プロパティ \| メソッド \| イベント