ChannelSet

パッケージ	mx.messaging
クラス	public class ChannelSet
継承	ChannelSet EventDispatcher Object
サブクラス	AdvancedChannelSet

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルトの MXML プロパティchannels

パブリックプロパティ

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

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

	プロパティ		定義元
		authenticated : Boolean [読み取り専用] ChannelSet に、エンドポイントで正常に認証された基本チャンネルがあるかどうかを示します。	ChannelSet
		channelIds : Array [読み取り専用] ChannelSet で使用されるチャンネルの ID です。	ChannelSet
		channels : Array ChannelSet 内のチャンネルへのアクセスを提供します。	ChannelSet
		clustered : Boolean ChannelSet がクラスタ化された宛先をターゲットにしているかどうかを示します。	ChannelSet
		connected : Boolean [読み取り専用] ChannelSet が接続されているかどうかを示します。	ChannelSet
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		currentChannel : Channel [読み取り専用] ChannelSet に現在のチャンネルを返します。	ChannelSet
		heartbeatInterval : int この ChannelSet がアクティブに接続されているがアイドルである間にリモートホストに送信されるハートビートの間隔（ミリ秒）。	ChannelSet
		initialDestinationId : String この ChannelSet がアクセスするために使用される最初の宛先へのアクセスを提供します。	ChannelSet
		messageAgents : Array [読み取り専用] この ChannelSet を使用する MessageAgents のセットへのアクセスを提供します。	ChannelSet

パブリックメソッド

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

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

	メソッド		定義元
		ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing: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
		disconnectAll():void すべての関連する MessageAgents と、接続されている基本チャンネルを切断します。	ChannelSet
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		login(username:String, password:String, charset:String = null):mx.rpc:AsyncToken 提供される資格情報を使用してサーバーで ChannelSet を認証します。	ChannelSet
		logout(agent:MessageAgent = null):mx.rpc:AsyncToken サーバーから ChannelSet をログアウトします。	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, charset:String = null):void 資格情報を保存し、接続中のすべてのチャンネルに送信します。	ChannelSet
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String [オーバーライド] ChannelSet 内のチャンネルの ID を含むストリングを返します。	ChannelSet
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

	メソッド		定義元
		messageHandler(event:MessageEvent):void 現在接続中のチャンネルからメッセージイベントを再送出します。	ChannelSet

イベント

イベントの詳細についてはここをクリックしてください

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

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

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
channelConnect	ChannelSet 内のチャンネルがエンドポイントに接続された後で送出されます。	ChannelSet
channelDisconnect	ChannelSet 内のチャンネルがエンドポイントから切断された後で送出されます。	ChannelSet
channelFault	ChannelSet 内のチャンネルでフォルトが発生した後で送出されます。	ChannelSet
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
fault	fault イベントは、ログインまたはログアウト呼び出しが失敗すると送出されます。	ChannelSet
propertyChange	ChannelSet のプロパティが変更されたときに送出されます。	ChannelSet
result	result イベントは、ログインまたはログアウト呼び出しが正常に返されると送出されます。	ChannelSet

プロパティの詳細

authenticated

プロパティ

authenticated:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet に、エンドポイントで正常に認証された基本チャンネルがあるかどうかを示します。

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

実装
public function get authenticated():Boolean

channelIds

プロパティ

channelIds:Array [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get channelIds():Array

channels

プロパティ

channels:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet 内のチャンネルへのアクセスを提供します。チャンネルのセットを一度に割り当てるために、このプロパティを使用することができます。または、addChannel() 経由で複数のチャンネルを個別に ChannelSet に直接追加することもできます。この ChannelSet が自動的に configured に設定されている場合、個々のチャンネルは非効率的に作成され、必要に応じてこのプロパティに追加されます。

実装
public function get channels():Array
public function set channels(value:Array):void

例外

IllegalOperationError — ChannelSet が configured の場合、このプロパティへの割り当てはできません。

clustered

プロパティ

clustered:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet がクラスタ化された宛先をターゲットにしているかどうかを示します。true の場合、接続が成功すると ChannelSet はチャンネルのクラスタ化されたすべてのエンドポイントの宛先を照会し、failoverURI をそれぞれのチャンネルに割り当てます。チャンネル ID は、failoverURI を適切なチャンネルインスタンスに割り当てるのに使用されます。このため、ChannelSet 内のすべてのチャンネルは null 以外の ID を保持する必要があります。そうでない場合にこのプロパティが true に設定されると、エラーがスローされます。ChannelSet のクライアントで URL ロードバランシングが使用されていない場合は、このプロパティを true に設定しないでください。

実装
public function get clustered():Boolean
public function set clustered(value:Boolean):void

connected

プロパティ

connected:Boolean [読み取り専用]

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

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

実装
public function get connected():Boolean

currentChannel

プロパティ

currentChannel:Channel [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet に現在のチャンネルを返します。

実装
public function get currentChannel():Channel

heartbeatInterval

プロパティ

heartbeatInterval:int

この ChannelSet がアクティブに接続されているがアイドルである間にリモートホストに送信されるハートビートの間隔（ミリ秒）。送信メッセージのトラフィックによって、ハートビートが一時的に遅延します（最後のメッセージが送信されてから、次のハートビートが発行されるまでに、この時間（ミリ秒）だけ経過します）。

このプロパティは、次のようなアプリケーションで便利です。プッシュされた更新を受信するためにリモートホストに接続して、メッセージをアクティブに送信していないが、接続の切断の通知を受け取るアプリケーションで便利です（ネットワークレイヤーがそうした通知を直接提供していない場合でも）。ハートビートを定期的に発行することにより、クライアントは、基になる接続が通知なしで切断されても、ネットワークレイヤーにタイムアウトを報告させることができます。また、アプリケーションは、切断に適切に対処することができます。

値が正でない場合は、リモートホストへのハートビートが無効になります。デフォルト値は 0 であり、ハートビートは無効です。アプリケーションでこの値を設定する場合は、リモートホストに不要な負荷をかけないために、短い間隔より長い間隔が推奨されます。実例として、通常、下位レベルの TCP ソケットのキープアライブは、デフォルトで 2 時間の間隔に設定されます。これは、ハートビートが有効なほとんどのアプリケーションが使用するよりも長い間隔ですが、短い間隔より長い間隔が推奨される分かりやすい例です。

現在接続している基になるチャネルがポーリング要求をホストに発行する場合は、ハートビートが抑止されます。それは、定期的なポーリング要求は、ハートビートの代わりとして有効に働くからです。

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

initialDestinationId

プロパティ

initialDestinationId:String

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

この ChannelSet がアクセスするために使用される最初の宛先へのアクセスを提供します。clustered プロパティが true の場合、この値は、宛先のために構成されたチャンネルで使用可能なフェイルオーバー URI を要求するために使用されます。

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

messageAgents

プロパティ

messageAgents:Array [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get messageAgents():Array

コンストラクターの詳細

()

コンストラクター

public function ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false)

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

ChannelSet が URL ロードバランシングを使用してクラスタ化されている場合、各サーバーは固有の RTMP または HTTP URL を宣言し、クライアントは URL から次の URL にフェイルオーバーします。この場合、ChannelSet 内のチャンネルが最初に接続に成功すると、ChannelSet はクラスタ内にあるすべてのメンバーチャンネルのすべてのエンドポイントに対するリクエストを自動的に作成し、これらのフェイルオーバー URL を対応する各チャンネルに割り当てます。これにより、ChannelSet 内のチャンネルは個別にフェイルオーバーできるようになり、特定のチャンネルのフェイルオーバーオプションがすべて使用できない場合、ChannelSet はセット内の次のチャンネルを使用して再接続を試みます。

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

パラメーター

	`channelIds:Array` (default = `null`) — この ChannelSet が使用する、ServerConfig から取得した設定済みのチャンネルの ID です。null の場合は、チャンネルを手動で ChannelSet に追加する必要があります。

	`clusteredWithURLLoadBalancing:Boolean` (default = `false`) — URL ロードバランシングを使用して ChannelSet 内のチャンネルがクラスタ化されている場合は true になります。

メソッドの詳細

addChannel

()

メソッド

public function addChannel(channel:Channel):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet にチャンネルを追加します。ChannelSet がクラスタ化された宛先をターゲットにしている場合、ID が null のチャンネルを ChannelSet に追加することはできません。

パラメーター

channel:Channel — 追加するチャンネルです。

例外

IllegalOperationError — ChannelSet が configured の場合、チャンネルの追加はサポートされません。このエラーは、ChannelSet の clustered プロパティが true でチャンネルの ID が null の場合にもスローされます。

channelConnectHandler

()

メソッド

public function channelConnectHandler(event:ChannelEvent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

event:ChannelEvent — ChannelEvent です。

channelDisconnectHandler

()

メソッド

public function channelDisconnectHandler(event:ChannelEvent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

event:ChannelEvent — ChannelEvent です。

channelFaultHandler

()

メソッド

public function channelFaultHandler(event:ChannelFaultEvent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

event:ChannelFaultEvent — ChannelFaultEvent です。

connect

()

メソッド

public function connect(agent:MessageAgent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

agent:MessageAgent — 接続する MessageAgent です。

disconnect

()

メソッド

public function disconnect(agent:MessageAgent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

特定の MessageAgent を ChannelSet から切断します。これが ChannelSet を使用する最後の MessageAgent であり、セット内の現在のチャンネルに接続している場合、チャンネルはサーバーから物理的に切断します。

パラメーター

agent:MessageAgent — 切断する MessageAgent です。

disconnectAll

()

メソッド

public function disconnectAll():void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

すべての関連する MessageAgents と、接続されている基本チャンネルを切断します。特定のサービスコンポーネントの切断の実装によって呼び出される disconnect(MessageAgent) とは異なり、このメソッドはクライアントとサーバー間の接続を終了するために役立つ単一ポイントをもたらします。

login

()

メソッド

public function login(username:String, password:String, charset:String = null):mx.rpc:AsyncToken

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

提供される資格情報を使用してサーバーで ChannelSet を認証します。チャンネルおよび ChannelSet でのほかの処理とは異なり、この処理は、成功または失敗を直接扱うためにクライアントコードで応答側を追加できる AsyncToken を返します。このメソッドが呼び出されたときに ChannelSet がサーバーに接続していない場合、接続試行がトリガーされます。試行が成功した場合、ログインコマンドをサーバーに送信します。一度に 1 つのログインまたはログアウト操作だけを保留にでき、呼び出しが重複すると IllegalOperationError が生成されます。ChannelSet が既に認証されているときにログインを呼び出した場合にも、IllegalOperationError が生成されます。

パラメーター

	`username:String` — ユーザー名です。

	`password:String` — パスワードです。

	`charset:String` (default = `null`) — 資格情報をエンコードする際に使用する文字セットエンコーディングです。デフォルトは null で、旧式文字セットの ISO-Latin-1 を示します。サポートされているその他の文字セットは "UTF-8" のみです。

戻り値

mx.rpc:AsyncToken — クライアントコードが成功または失敗を直接処理するために応答側を追加できるトークンを返します。

例外

IllegalOperationError — ChannelSet が既に認証されている場合、またはログインまたはログアウト操作が現在進行中である場合の 2 つの状況があります。

logout

()

メソッド

public function logout(agent:MessageAgent = null):mx.rpc:AsyncToken

サーバーから ChannelSet をログアウトします。チャンネルおよび ChannelSet でのほかの処理とは異なり、この処理は、成功または失敗を直接扱うためにクライアントコードで応答側を追加できる AsyncToken を返します。ログアウトが成功すると、自動再接続用にキャッシュされている資格情報が ChannelSet に対してクリアされ、そのチャンネルと認証状態が false に設定されます。このメソッドが呼び出されたときに ChannelSet がサーバーに接続していない場合、接続試行がトリガーされます。試行が成功した場合、ログアウトコマンドをサーバーに送信します。

MessageAgent 引数は古いログアウト動作をサポートするために存在しており、このメソッドを呼び出すクライアントコードは MessageAgent 参照を渡しません。単に logout() を呼び出すだけで、引数は渡しません。

また、このメソッドは logout() メソッドからサービスコンポーネントによって呼び出されます。これらのコンポーネントは、ログアウトするときに MessageAgent 参照をこのメソッドに渡します。この引数が存在すると、上記の新しい動作とは異なる古いログアウト動作が実行されます。古い動作は、クライアントが接続および認証された場合にログアウト要求をサーバーに送信するだけです。これらの条件が満たされない場合、このメソッドの古い動作は、自動再接続用にキャッシュされた資格情報をクリアするだけです。

パラメーター

agent:MessageAgent (default = null) — 古い引数。ログアウトを開始する MessageAgent です。

戻り値

mx.rpc:AsyncToken — クライアントコードが成功または失敗を直接処理するために応答側を追加できるトークンを返します。

例外

IllegalOperationError — ログインまたはログアウト処理が現在進行中の場合。

messageHandler

()

メソッド

protected function messageHandler(event:MessageEvent):void

現在接続中のチャンネルからメッセージイベントを再送出します。

パラメーター

event:MessageEvent — チャンネルの MessageEvent。

removeChannel

()

メソッド

public function removeChannel(channel:Channel):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

channel:Channel — 削除するチャンネルです。

例外

IllegalOperationError — ChannelSet が configured の場合、チャンネルの削除はサポートされません。

send

()

メソッド

public function send(agent:MessageAgent, message:IMessage):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

	`agent:MessageAgent` — メッセージを送信する MessageAgent です。

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

例外

NoChannelAvailableError — ChannelSet が使用する内部チャンネルがない場合。

setCredentials

()

メソッド

public function setCredentials(credentials:String, agent:MessageAgent, charset:String = null):void

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

	`credentials:String` — MessageAgent の証明書です。

	`agent:MessageAgent` — 証明書を設定する MessageAgent です。

	`charset:String` (default = `null`) — 資格情報をエンコードする際に使用された文字セットエンコーディングです。デフォルトは null で、旧式エンコーディングの ISO-Latin-1 を示します。

例外

IllegalOperationError — 2 つの状況：資格情報が既に設定済みでリモートの宛先の認証が進行中である場合、または指定した認証済みの資格情報が現在の認証済みの資格情報と一致しない場合。

toString

()

メソッド

override public function toString():String

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet 内のチャンネルの ID を含むストリングを返します。

戻り値

String — ChannelSet のストリング表現です。

イベントの詳細

channelConnect

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

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

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

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

channelDisconnect

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

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

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

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

channelFault

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

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

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

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

fault

イベント

イベントオブジェクトの型: mx.rpc.events.FaultEvent
プロパティ FaultEvent.type = mx.rpc.events.FaultEvent.FAULT

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

fault イベントは、ログインまたはログアウト呼び出しが失敗すると送出されます。

FAULT イベントタイプです。

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

プロパティ	値
`bubbles`	false
`cancelable`	true。関連付けられたトークンの responder.fault メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`fault`	このイベントの原因についての詳細が含まれる Fault オブジェクトです。
`message`	このイベントに関連付けられたメッセージです。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`token`	メソッドの呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。

propertyChange

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ChannelSet のプロパティが変更されたときに送出されます。

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

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

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

result

イベント

イベントオブジェクトの型: mx.rpc.events.ResultEvent
プロパティ ResultEvent.type = mx.rpc.events.ResultEvent.RESULT

言語バージョン:

ActionScript 3.0

製品バージョン:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

result イベントは、ログインまたはログアウト呼び出しが正常に返されると送出されます。

RESULT イベントタイプです。

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

プロパティ	値
`bubbles`	false
`cancelable`	true。関連付けられたトークンの responder.result メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`message`	このイベントに関連付けられたメッセージです。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`result`	RPC 呼び出しが返す結果です。
`token`	メソッドの個々の呼び出しを表すトークン。 Asynchronous Completion Token パターンで使用されます。

法律上の注意 | プライバシーポリシー

ChannelSet - AS3 BlazeDS LCDS

クラス x

authenticated

channelIds

channels

clustered

connected

currentChannel

heartbeatInterval

initialDestinationId

messageAgents

ChannelSet

addChannel

channelConnectHandler

channelDisconnectHandler

channelFaultHandler

connect

disconnect

disconnectAll

login

logout

messageHandler

removeChannel

send

setCredentials

toString

channelConnect

channelDisconnect

channelFault

fault

propertyChange

result