(BlazeDS のみ)
パッケージmx.messaging
クラスpublic class AbstractProducer
継承AbstractProducer Inheritance MessageAgent Inheritance EventDispatcher Inheritance Object
サブクラス MultiTopicProducer, Producer

AbstractProducer は、プロデューサクラスと MultiTopicConsumer クラスの基本クラスです。これらのクラスを使用してメッセージをサーバーにプッシュします。



パブリックプロパティ
 プロパティ定義元
 Inheritedauthenticated : Boolean
[読み取り専用] この MessageAgent が宛先への接続に認証を使用するかどうかを示します。
MessageAgent
  autoConnect : Boolean
true の場合、send() メソッドが初めて呼び出されると、プロデューサは自動的に宛先に接続します。
AbstractProducer
 InheritedchannelSet : ChannelSet
MessageAgent が使用する ChannelSet へのアクセスを提供します。
MessageAgent
 InheritedclientId : String
[読み取り専用] MessageAgent のクライアント ID へのアクセスを提供します。
MessageAgent
 Inheritedconnected : Boolean
[読み取り専用] この MessageAgent が現在、ChannelSet を介して宛先に接続されているかどうかを示します。
MessageAgent
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  defaultHeaders : Object
プロデューサで送信されるメッセージに適用するデフォルトヘッダーです。
AbstractProducer
 Inheriteddestination : String
MessageAgent の宛先へのアクセスを提供します。
MessageAgent
  priority : int
プロデューサが送信するメッセージのデフォルトメッセージ優先度です。
AbstractProducer
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  reconnectAttempts : int
宛先が利用できない場合、または宛先への接続が閉じられた場合に、プロデューサが再接続を試行する回数です。
AbstractProducer
  reconnectInterval : int
再接続を試行する間隔 (ミリ秒数) です。
AbstractProducer
 InheritedrequestTimeout : int
送信メッセージの要求タイムアウト時間(秒単位)に対するアクセスを提供します。
MessageAgent
パブリックメソッド
 メソッド定義元
 Inherited
送信されたメッセージの結果を受信したときに MessageResponder によって呼び出されます。
MessageAgent
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
CONNECT ChannelEvent を処理します。
MessageAgent
 Inherited
DISCONNECT ChannelEvent を処理します。
MessageAgent
 Inherited
ChannelFaultEvent を処理します。
MessageAgent
  
プロデューサをターゲットの宛先に接続します。
AbstractProducer
  
[override] プロデューサをリモート宛先から切断します。
AbstractProducer
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
送信されたメッセージの失敗を受信したときに、MessageResponder によって呼び出されます。
MessageAgent
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
渡されたメッセージに対し保留の要求がある場合、true を返します。
MessageAgent
 Inherited
実装オブジェクトが作成され、タグに指定されたすべてのプロパティが割り当てられた後に呼び出されます。
MessageAgent
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
MessageAgent をリモート宛先からログアウトします。
MessageAgent
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
send(message:IMessage):void
指定されたメッセージを宛先に送信します。
AbstractProducer
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
MessageAgent が宛先の認証に使用する証明書を設定します。
MessageAgent
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
setRemoteCredentials(username:String, password:String, charset:String = null):void
セカンダリシステムへの認証のためにリモート宛先に渡すリモート資格情報を設定します。
MessageAgent
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
MessageAgent の初回の接続前に MessageAgent の channelSet プロパティを自動的に初期化します。
MessageAgent
 Inherited
internalSend(message:IMessage, waitForClientId:Boolean = true):void
エージェントの ChannelSet を使って、MessageAgent から宛先にメッセージを送信します。
MessageAgent
 Inherited
この関数をサブクラスでオーバーライドして、サブクラス固有のサーバーセッションタイムアウト動作による再認証を実装する必要があります。
MessageAgent
イベント
 イベント 概要 定義元
 Inherited送信したメッセージに対する応答メッセージを受信したときに送出されます。MessageAgent
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 InheritedMessageAgent が使用中の基本チャンネルが接続されたときに送出されます。MessageAgent
 InheritedMessageAgent が使用中の基本チャンネルが切断されたときに送出されます。MessageAgent
 InheritedMessageAgent が使用中の基本チャンネルでエラーが発生したときに送出されます。MessageAgent
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inheritedメッセージエラーが発生したときに送出されます。MessageAgent
 InheritedMessageAgent の connected プロパティが変更されたときに送出されます。MessageAgent
プロパティの詳細
autoConnectプロパティ
autoConnect:Boolean

true の場合、send() メソッドが初めて呼び出されると、プロデューサは自動的に宛先に接続します。false の場合、connect() メソッドを明示的に呼び出して宛先への接続を確立する必要があります。デフォルトでは、このプロパティは true ですが、オフラインモードで動作する必要があるアプリケーションは、このプロパティを false に設定して send() メソッドが暗黙的に接続されないようにすることがあります。

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



実装
    public function get autoConnect():Boolean
    public function set autoConnect(value:Boolean):void
defaultHeadersプロパティ 
defaultHeaders:Object

プロデューサで送信されるメッセージに適用するデフォルトヘッダーです。メッセージ内にデフォルトヘッダーが存在しない場合は、デフォルトヘッダーが作成されます。メッセージ内に一致するヘッダーが既に存在する場合は、メッセージ内の値が優先されて、デフォルトのヘッダー値は無視されます。

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



実装
    public function get defaultHeaders():Object
    public function set defaultHeaders(value:Object):void
priorityプロパティ 
priority:int

プロデューサが送信するメッセージのデフォルトメッセージ優先度です。有効な値は 0 ~ 9 (0 が最小)です。-1 の場合、プロデューサには優先度が設定されません。メッセージに優先度が定義済みの場合は、その優先度がプロデューサの優先度より優先されることに注意してください。

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



実装
    public function get priority():int
    public function set priority(value:int):void
reconnectAttemptsプロパティ 
reconnectAttempts:int

宛先が利用できない場合、または宛先への接続が閉じられた場合に、プロデューサが再接続を試行する回数です。値 -1 を指定すると、無限の回数で試行できます。0 の値を指定すると再接続試行を無効にします。

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

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



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

関連項目

reconnectIntervalプロパティ 
reconnectInterval:int

再接続を試行する間隔 (ミリ秒数) です。プロデューサが接続試行に対する応答を受け取らなかった場合、指定されたミリ秒数待ってから以降の再接続を試みます。値を 0 に設定すると再接続試行が無効になります。

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

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



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

例外
ArgumentError — 負の値が割り当てられた場合。

関連項目

メソッドの詳細
connect()メソッド
public function connect():void

プロデューサをターゲットの宛先に接続します。接続が確立すると、connected プロパティが true に変更されます。このプロパティはバインド可能であり、PropertyChangeEvent を生成します。送信される内部 TRIGGER_CONNECT_OPERATION CommandMessage は、基本チャンネルが接続を確立しているかどうかに応じて、応答またはフォールトイベントになります。


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


例の使用法
         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         producer.addEventListener(PropertyChangeEvent.PROPERTY_CHANGE, handleConnect);
         producer.connect();
      
disconnect()メソッド 
override public function disconnect():void

プロデューサをリモート宛先から切断します。このメソッドは、未処理のネットワーク操作が完了するまで待つことはしません。disconnect() を呼び出した後、プロデューサは、接続されておらず、未処理のメッセージ応答またはフォルトを受信しないことを報告します。切断すると、実行している自動再接続試行が停止します。

send()メソッド 
public function send(message:IMessage):void

指定されたメッセージを宛先に送信します。プロデューサがパブリッシュまたはサブスクライブメッセージングに使用されている場合は、AsyncMessage タイプのメッセージのみが送信されます。ただし、カスタムメッセージタイプが使用されていて、サーバー上のメッセージ宛先がカスタムメッセージタイプを処理するように設定されている場合は、この限りではありません。

パラメータ

message:IMessage — 送信するメッセージです。


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


例の使用法
         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         var msg:AsyncMessage = new AsyncMessage();
         msg.body = "test message";
         producer.send(msg);
      




 

 

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

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