mx.messaging.AbstractConsumer （Flex 3.2）

	プロパティ	定義元
		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
		subscribed : Boolean [読み取り専用] コンシューマが現在サブスクライブされているかどうかを示します。	AbstractConsumer
		timestamp : Number このコンシューマが受信した最新のメッセージのタイムスタンプが含まれます。	AbstractConsumer

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

パブリックメソッド

	メソッド		定義元
		AbstractConsumer() コンシューマを作成します。	AbstractConsumer
		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	コンシューマがメッセージを受信したときに送出されます。	AbstractConsumer
propertyChange	MessageAgent の connected プロパティが変更されたときに送出されます。	MessageAgent

プロパティの詳細

_shouldBeSubscribed

プロパティ

protected var _shouldBeSubscribed:Boolean

このコンシューマをサブスクライブするかどうかを示すフラグです。

maxFrequency

プロパティ

maxFrequency:uint

コンシューマが毎秒受信を希望する最大メッセージ数を決定します。この値を理解するサーバーは、これを入力として使用し、コンシューマへのメッセージ送信速度を決定します。デフォルトは 0 です。つまり、コンシューマにはメッセージ速度に関する環境設定がありません。コンシューマがサブスクラブする前にこのプロパティを設定する必要があること、コンシューマのサブスクリプション後の変更はコンシューマがサブスクライブを解除し再サブスクライブするまで効果がないことに注意してください。

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

実装
public function get maxFrequency():uint
public function set maxFrequency(value:uint):void

resubscribeAttempts

プロパティ

resubscribeAttempts:int

宛先が利用できない場合、または宛先への接続が失敗した場合に、コンシューマが再サブスクライブを試行する回数です。値 -1 を指定すると、無限の回数で試行できます。0 の値を指定すると再サブスクライブ試行を無効にします。

再サブスクライブ試行は、再サブスクライブ間隔値に従って一定の割合で行われます。再サブスクライブ試行が行われるときに、コンシューマの基本チャンネルが接続されていない、または接続しようとしている場合、チャンネルが接続試行を開始します。基本チャンネルの接続試行が未処理の間にコンシューマの再サブスクライブ試行が続いて行われても、未処理のチャンネル接続試行が成功または失敗するまで、事実上無視されます。

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

実装
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void

subscribed

プロパティ

subscribed:Boolean [読み取り専用]

コンシューマが現在サブスクライブされているかどうかを示します。このプロパティが変更されると、propertyChange イベントが送出されます。

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

実装
public function get subscribed():Boolean

timestamp

プロパティ

timestamp:Number

このコンシューマが受信した最新のメッセージのタイムスタンプが含まれます。この値は receive() 呼び出しで宛先に渡され、宛先に、このタイムスタンプ以降のコンシューマに対するメッセージを配信するように要求します。ポーリング処理時に、timestamp 値より大きいタイムスタンプ値を持つすべてのメッセージが返されます。この値を -1 に設定すると、宛先からすべてのキャッシュされたメッセージが取得されます。

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

実装
public function get timestamp():Number
public function set timestamp(value:Number):void

コンストラクタの詳細

AbstractConsumer

()

コンストラクタ

public function AbstractConsumer()

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

例

       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());
       }

メソッドの詳細

buildSubscribeMessage

()

メソッド

protected function buildSubscribeMessage():CommandMessage

サブスクライブメッセージを返します。サブクラスがカスタムのサブスクライブメッセージを必要とする場合、このメソッドをサブクラスでオーバーライドする必要があります。

戻り値

CommandMessage — サブスクライブ CommandMessage です。

buildUnsubscribeMessage

()

メソッド

protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

アンサブスクライブメッセージを返します。サブクラスがカスタムのアンサブスクライブメッセージを必要とする場合、このメソッドをサブクラスでオーバーライドする必要があります。

パラメータ

preserveDurable:Boolean — - true の場合、持続性のある JMS サブスクリプションは破棄されず、コンシューマは失われたメッセージを後から再サブスクライブおよび受信できます。

戻り値

CommandMessage — アンサブスクライブ CommandMessage です。

disconnect

()

メソッド

override public function disconnect():void

コンシューマをリモート宛先から切断します。このメソッドは、アンサブスクライブ後にアプリケーションで不要となったコンシューマに対して呼び出す必要があります。このメソッドは未完了のネットワーク処理が完了するまで待たず、サーバーにアンサブスクライブメッセージも送信しません。disconnect() を呼び出した後、コンシューマは切断およびアンサブスクライブ状態であることを報告します。これは、コンシューマが再接続して再サブスクライブするまでメッセージを受信しないためです。切断すると、実行している自動再サブスクリプション試行が停止します。

receive

()

メソッド

public function receive(timestamp:Number = 0):void

サーバー上のこのコンシューマに対してキューに置かれているメッセージを要求します。このメソッドは、非リアルタイムの非ポーリングチャンネルでサブスクライブするコンシューマにのみ使用します。このメソッドは、コンシューマがサブスクライブされない場合、no-op です。

パラメータ

timestamp:Number (default = 0) — この引数は推奨されていないので、無視されます。

()

メソッド

public function subscribe(clientId:String = null):void

リモート宛先にサブスクライブします。

パラメータ

clientId:String (default = null) — サブスクライブに使用するクライアント ID。持続性のないコンシューマには null を使用します。サブスクリプションに持続性がある場合、コンシューマがサブスクライブするたびにリモート宛先の正しい持続性サブスクリプションに再接続できるよう、毎回一貫した値を入力する必要があります。

例外

InvalidDestinationError — 宛先が設定されていない場合。

unsubscribe

()

メソッド

public function unsubscribe(preserveDurable:Boolean = false):void

リモート宛先からサブスクライブ解除します。持続性のある JMS サブスクリプションの場合、これを実行すると JMS サーバーの持続性サブスクリプションが破棄されます。

パラメータ

preserveDurable:Boolean (default = false) — - true の場合、持続性のある JMS サブスクリプションは破棄されず、コンシューマは失われたメッセージを後から再サブスクライブおよび受信できます。

イベントの詳細

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/AbstractConsumer.html

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

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