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

プロパティの詳細

connected

プロパティ

connected:Boolean [読み取り専用]

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

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

実装
public function get connected():Boolean

heartbeatInterval

プロパティ

heartbeatInterval:int

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

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

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

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

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

コンストラクターの詳細

メソッドの詳細

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。

イベントの詳細

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

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

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

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

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

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

ChannelSet - AS3 BlazeDS LCDS

パッケージx

言語エレメント

付録

パッケージ mx.messaging

authenticated

channelIds

channels

clustered

connected

currentChannel

heartbeatInterval

initialDestinationId

messageAgents

addChannel

channelConnectHandler

channelDisconnectHandler

channelFaultHandler

connect

disconnect

disconnectAll

login

logout

messageHandler

removeChannel

send

setCredentials

toString

channelConnect

channelDisconnect

channelFault

fault

propertyChange

result

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

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

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

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

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

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

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

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

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

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