mx.messaging.ChannelSet (Flex™ 2 リファレンスガイド)

	プロパティ	定義
		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
		constructor : Object 特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		messageAgents : Array [read-only] この ChannelSet を使用する MessageAgents のセットへのアクセスを提供します。	ChannelSet
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object

	メソッド	定義
		ChannelSet(channelIds:Array = null, clustered:Boolean = false) ChannelSet を作成します。	ChannelSet
		addChannel(channel:Channel):void ChannelSet にチャンネルを追加します。	ChannelSet
		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
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		logout(agent:MessageAgent):void 保存されている資格情報をクリアし、セット内のすべてのチャンネルに対してログアウトを呼び出します。	ChannelSet
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙可能かどうかを示します。	Object
		removeChannel(channel:Channel):void ChannelSet からチャンネルを削除します。	ChannelSet
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String ChannelSet 内のチャンネルの ID を返します。	ChannelSet
		valueOf():Object 指定されたオブジェクトのプリミティブ値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

一覧	定義
channelConnect	ChannelSet 内のチャンネルがエンドポイントに接続された後で送出されます。	ChannelSet
channelDisconnect	ChannelSet 内のチャンネルがエンドポイントから切断された後で送出されます。	ChannelSet
channelFault	ChannelSet 内のチャンネルでフォルトが発生した後で送出されます。	ChannelSet
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

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 のストリング表現です。

イベントの詳細

channelConnect

event

イベントオブジェクトの型: mx.messaging.events.ChannelEvent
ChannelEvent.type property = mx.messaging.events.ChannelEvent.CONNECT

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

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

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

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

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

channelDisconnect

event

イベントオブジェクトの型: mx.messaging.events.ChannelEvent
ChannelEvent.type property = mx.messaging.events.ChannelEvent.DISCONNECT

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

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

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

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

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

channelFault

event

イベントオブジェクトの型: mx.messaging.events.ChannelFaultEvent
ChannelFaultEvent.type property = mx.messaging.events.ChannelFaultEvent.FAULT

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

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

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

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

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

propertyChange

event

イベントオブジェクトの型: 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` プロパティを使用してください。

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class ChannelSet	プロパティ \| メソッド \| イベント

パッケージ	mx.messaging
	public class ChannelSet
継承	ChannelSet EventDispatcher Object