(Adobe® Flex™ Data Services 2 のみ)
パッケージmx.messaging
public class ChannelSet
継承ChannelSet Inheritance EventDispatcher Inheritance Object

ChannelSet は、ターゲット宛先へのメッセージ送信に使用されるチャネルのセットです。ChannelSet は、ネットワーク障害や個々のチャネルの問題が発生したときに、セット内のチャネルを最大限活用してメッセージを送信することで、クライアントのサービスの質を向上させます。


パブリックプロパティ
 プロパティ定義
  channelIds : Array
[read-only] ChannelSet で使用されるチャネルの ID です。
ChannelSet
  clustered : Boolean
[read-only] ChannelSet がクラスタ化された宛先をターゲットにしているかどうかを示します。
ChannelSet
  configured : Boolean
[read-only] ChannelSet で使用しているチャネルが自動設定されたチャネルか、手動で割り当てられたチャネルかを示します。
ChannelSet
  connected : Boolean
[read-only] ChannelSet が接続されているかどうかを示します。
ChannelSet
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  currentChannel : Channel
[read-only] このチャネルセットの現在のチャネルを返します。
ChannelSet
  messageAgents : Array
[read-only] この ChannelSet を使用する MessageAgents のセットへのアクセスを提供します。
ChannelSet
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリック Methods
 メソッド定義
  
ChannelSet(channelIds:Array = null, clustered:Boolean = false)
ChannelSet を作成します。
ChannelSet
  
addChannel(channel:Channel):void
ChannelSet にチャネルを追加します。
ChannelSet
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。
EventDispatcher
  
channelConnectHandler(event:ChannelEvent):void
CONNECT ChannelEvent を処理してイベントを再送出します。
ChannelSet
  
channelDisconnectHandler(event:ChannelEvent):void
DISCONNECT ChannelEvent を処理してイベントを再送出します。
ChannelSet
  
channelFaultHandler(event:ChannelFaultEvent):void
ChannelFaultEvent イベントを処理し、そのイベントを再送出します。
ChannelSet
  
connect(agent:MessageAgent):void
MessageAgent を ChannelSet に接続します。
ChannelSet
  
disconnect(agent:MessageAgent):void
MessageAgent を ChannelSet から切断します。
ChannelSet
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
logout(agent:MessageAgent):void
保存されている資格情報をクリアし、セット内のすべてのチャネルに対してログアウトを呼び出します。
ChannelSet
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
removeChannel(channel:Channel):void
ChannelSet からチャネルを削除します。
ChannelSet
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
send(agent:MessageAgent, message:IMessage):void
現在接続中のチャネルを通じて MessageAgent からメッセージを送信します。
ChannelSet
  
setCredentials(credentials:String, agent:MessageAgent):void
資格情報を保存し、接続中のすべてのチャネルに送信します。
ChannelSet
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
toString():String
ChannelSet 内のチャネルの ID を返します。
ChannelSet
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
 Inherited
activate
Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
  
channelConnect
ChannelSet 内のチャネルがエンドポイントに接続された後で送出されます。ChannelSet
  
channelDisconnect
ChannelSet 内のチャネルがエンドポイントから切断された後で送出されます。ChannelSet
  
channelFault
ChannelSet 内のチャネルでフォルトが発生した後で送出されます。ChannelSet
 Inherited
deactivate
Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
  
propertyChange
チャネルセットのプロパティが変更されたときに送出されます。ChannelSet
プロパティの詳細
channelIdsプロパティ
channelIds:Array  [read-only]

ChannelSet で使用されるチャネルの ID です。

実装
    public function get channelIds():Array
clusteredプロパティ 
clustered:Boolean  [read-only]

ChannelSet がクラスタ化された宛先をターゲットにしているかどうかを示します。true の場合、接続が成功すると ChannelSet はチャネルのクラスタ化されたすべてのエンドポイントの宛先を照会し、これらのフェイルオーバー URI をそれぞれのチャネルに割り当てます。

実装
    public function get clustered():Boolean
configuredプロパティ 
configured:Boolean  [read-only]

ChannelSet で使用しているチャネルが自動設定されたチャネルか、手動で割り当てられたチャネルかを示します。

実装
    public function get configured():Boolean
connectedプロパティ 
connected:Boolean  [read-only]

ChannelSet が接続されているかどうかを示します。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get connected():Boolean
currentChannelプロパティ 
currentChannel:Channel  [read-only]

このチャネルセットの現在のチャネルを返します。

実装
    public function get currentChannel():Channel
messageAgentsプロパティ 
messageAgents:Array  [read-only]

この ChannelSet を使用する MessageAgents のセットへのアクセスを提供します。

実装
    public function get messageAgents():Array
コンストラクタの詳細
ChannelSet()コンストラクタ
public 関数 ChannelSet(channelIds:Array = null, clustered:Boolean = false)

ChannelSet を作成します。channelIds パラメータが指定されている場合、ChannelSet は ServerConfig.getChannel() で取得された指定のチャネルを使って宛先に接続します。ターゲットが設定済みの ChannelSet にチャネルを手動で割り当てることはできません。

channelIds パラメータが指定されていない場合、または null の場合は、接続してメッセージを送信するために、チャネルを手動で作成して ChannelSet に追加する必要があります。

ChannelSet がクラスタ化されている場合、ChannelSet はいずれかのチャネルに初めて接続すると、自動的にセット内のチャネルごとにクラスタ全域のすべてのエンドポイントを要求し、このフェイルオーバー URI をそれぞれのチャネルに割り当てます。これにより、ChannelSet 内のチャネルのフェイルオーバーが可能になり、1 つのチャネルのフェイルオーバーを使い切ると、ChannelSet はセット内の次の使用可能なチャネルに進むことができます。

クラスタ化とは関係なく、チャネルが接続を確立できない場合、または接続が失われた場合は、ChannelSet は次の使用可能なチャネルを使用して再接続を試みます。これにより、ChannelSet はさまざまなプロトコル、ポートなどを使用するチャネルの中から、エンドポイントに正常に接続できるチャネルを取得することができます。

パラメータ
channelIds:Array (default = null) — この ChannelSet が使用する設定済みのチャネルの IDです。null の場合は、チャネルを手動で ChannelSet に追加する必要があります。
 
clustered:Boolean (default = false) — ChannelSet 内のチャネルがクラスタ化されている場合は true で、クラスタ化されていない場合は false です。
メソッドの詳細
addChannel()メソッド
public function addChannel(channel:Channel):void

ChannelSet にチャネルを追加します。

パラメータ
channel:Channel — 追加するチャネルです。

スロー
IllegalOperationError — ChannelSet が configured の場合、チャネルの追加はサポートされません。
channelConnectHandler()メソッド 
public function channelConnectHandler(event:ChannelEvent):void

CONNECT ChannelEvent を処理してイベントを再送出します。

パラメータ
event:ChannelEvent — ChannelEvent です。
channelDisconnectHandler()メソッド 
public function channelDisconnectHandler(event:ChannelEvent):void

DISCONNECT ChannelEvent を処理してイベントを再送出します。

パラメータ
event:ChannelEvent — ChannelEvent です。
channelFaultHandler()メソッド 
public function channelFaultHandler(event:ChannelFaultEvent):void

ChannelFaultEvent イベントを処理し、そのイベントを再送出します。

パラメータ
event:ChannelFaultEvent — ChannelFaultEvent です。
connect()メソッド 
public function connect(agent:MessageAgent):void

MessageAgent を ChannelSet に接続します。ChannelSet に接続されると、エージェントが ChannelSet を使ってメッセージを送信できます。

パラメータ
agent:MessageAgent — 接続する MessageAgent です。
disconnect()メソッド 
public function disconnect(agent:MessageAgent):void

MessageAgent を ChannelSet から切断します。

パラメータ
agent:MessageAgent — 切断する MessageAgent です。
logout()メソッド 
public function logout(agent:MessageAgent):void

保存されている資格情報をクリアし、セット内のすべてのチャネルに対してログアウトを呼び出します。

パラメータ
agent:MessageAgent — ログアウトを開始する MessageAgent です。
removeChannel()メソッド 
public function removeChannel(channel:Channel):void

ChannelSet からチャネルを削除します。削除するチャネルが現在接続中で ChannelSet がこれを使用している場合、チャネルは切断されます。

パラメータ
channel:Channel — 削除するチャネルです。

スロー
IllegalOperationError — ChannelSet が configured の場合、チャネルの削除はサポートされません。
send()メソッド 
public function send(agent:MessageAgent, message:IMessage):void

現在接続中のチャネルを通じて MessageAgent からメッセージを送信します。

パラメータ
agent:MessageAgent — メッセージを送信する MessageAgent です。
 
message:IMessage — 送信するメッセージです。

スロー
NoChannelAvailableError — ChannelSet が使用する内部チャネルがない場合。
setCredentials()メソッド 
public function setCredentials(credentials:String, agent:MessageAgent):void

資格情報を保存し、接続中のすべてのチャネルに送信します。

パラメータ
credentials:String — MessageAgent の証明書です。
 
agent:MessageAgent — 証明書を設定する MessageAgent です。
toString()メソッド 
public override function toString():String

ChannelSet 内のチャネルの ID を返します。

戻り値
String — ChannelSet のストリング表現です。
イベントの詳細
channelConnectevent 
イベントオブジェクトの型: mx.messaging.events.ChannelEvent
ChannelEvent.type property = mx.messaging.events.ChannelEvent.CONNECT

ChannelSet 内のチャネルがエンドポイントに接続された後で送出されます。

CONNECT イベント型。チャネルがエンドポイントに接続されたことを示します。

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

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

プロパティ値
bubblesfalse
cancelablefalse
channelこのイベントがトリガされたチャネルです。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
reconnecting このイベントを生成したチャネルが再接続中かどうかを示します。
rejected このイベントを生成したチャネルが拒否されたかどうかを示します。アクティビティがないことによりチャネルが切断された場合は、これが true になり、フェイルオーバーが行われず、代替チャネルへの接続も行われません。
channelDisconnectevent  
イベントオブジェクトの型: mx.messaging.events.ChannelEvent
ChannelEvent.type property = mx.messaging.events.ChannelEvent.DISCONNECT

ChannelSet 内のチャネルがエンドポイントから切断された後で送出されます。

DISCONNECT イベント型。チャネルがエンドポイントから切断されたことを示します。

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

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

プロパティ値
bubblesfalse
cancelablefalse
channelこのイベントがトリガされたチャネルです。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
reconnecting このイベントを生成したチャネルが再接続中かどうかを示します。
rejected このイベントを生成したチャネルが拒否されたかどうかを示します。アクティビティがないことによりチャネルが切断された場合は、これが true になり、フェイルオーバーが行われず、代替チャネルへの接続も行われません。
channelFaultevent  
イベントオブジェクトの型: mx.messaging.events.ChannelFaultEvent
ChannelFaultEvent.type property = mx.messaging.events.ChannelFaultEvent.FAULT

ChannelSet 内のチャネルでフォルトが発生した後で送出されます。

FAULT イベント型。フォルトが発生したチャネルを示します。

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

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

プロパティ値
bubblesfalse
cancelablefalse
channelこのイベントを生成したチャネル。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
faultCode失敗に関する宛先固有の詳細を提供します。
faultDetail失敗の宛先固有の理由へのアクセスを提供します。
faultStringチャネル自体がフォルトを生成しなかった場合は、フォルトの根本的な理由へのアクセスを提供します。
reconnecting このイベントを生成したチャネルが再接続中かどうかを示します。
rootCause チャネル自体がフォルトを生成しなかった場合は、フォルトの根本的な理由へのアクセスを提供します。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
propertyChangeevent  
イベントオブジェクトの型: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = mx.events.PropertyChangeEvent.PROPERTY_CHANGE

チャネルセットのプロパティが変更されたときに送出されます。

PropertyChangeEvent.PROPERTY_CHANGE 定数により、PropertyChange イベントのイベントオブジェクトの type プロパティ値が定義されます。

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

プロパティ値
bubblesコンストラクタによって決定されます。デフォルトは false です。
cancelableコンストラクタによって決定されます。デフォルトは false です。
kind変更の種類。PropertyChangeEventKind.UPDATE または PropertyChangeEventKind.DELETE のいずれかです。
oldValue元のプロパティの値です。
newValue新しいプロパティの値 (存在する場合) です。
property変更されたプロパティです。
source変更されたプロパティを含むオブジェクトです。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
2007.04.26, 午前 9:17, GMT-07:00