Channel

パッケージ	mx.messaging
クラス	public class Channel
継承	Channel EventDispatcher Object
実装	IMXMLObject
サブクラス	PollingChannel

言語バージョン:

ActionScript 3.0

製品バージョン:

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

ランタイムバージョン:

Flash Player 9, AIR 1.1

Channel クラスは、メッセージングシステム内のすべてのチャンネルで拡張する必要がある基本メッセージチャンネルクラスです。

チャンネルは、MessageAgents とリモート宛先間で送信されるメッセージにとって、特定プロトコルベースのパイプとなります。 ServerConfig.getChannel() メソッドで、フレームワーク内の設定済みチャンネルが取得されます。 new 演算子を使って直接チャンネルを作成し、ChannelSet に直接追加することもできます。

チャンネルは、リモートエンドポイントへの物理接続を表します。デフォルトでは、複数の宛先の間でチャンネルが共有されます。つまり、複数の宛先をターゲットとしているクライアントでは、それらの宛先との通信に同一のチャンネルを使用することがあります。

メモ：このクラスは高度な使用のみを目的としています。既存の RTMPChannel、AMFChannel、および HTTPChannel などのカスタムチャンネルを作成する場合に、このクラスを使用します。

パブリックプロパティ

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

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

	プロパティ		定義元
		authenticated : Boolean [読み取り専用] このチャンネルを認証するかどうかを示します。	Channel
		channelSets : Array [読み取り専用] チャンネルに接続された ChannelSet へのアクセスを提供します。	Channel
		connected : Boolean [読み取り専用] このチャンネルがリモート宛先との接続を確立しているかどうかを示します。	Channel
		connectTimeout : int チャンネルに対する接続タイムアウト時間（秒単位）へのアクセスを提供します。	Channel
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		endpoint : String [読み取り専用] このチャンネルのエンドポイントへのアクセスを提供します。	Channel
		failoverURIs : Array エンドポイントがクラスタ化されている場合に、このチャンネルがフェイルオーバーを試行できるエンドポイント URI のセットへのアクセスを提供します。	Channel
		id : String このチャンネルの ID へのアクセスを提供します。	Channel
		protocol : String [読み取り専用] チャンネルが使用するプロトコルへのアクセスを提供します。	Channel
		reconnecting : Boolean [読み取り専用] このチャンネルが代替エンドポイントへの再接続を実行中であるかどうかを示します。	Channel
		recordMessageSizes : Boolean [読み取り専用] Channel プロパティは、パフォーマンス情報のインジェクションレベル (メッセージのサイズをインジェクトするかどうか) を決定します。	Channel
		recordMessageTimes : Boolean [読み取り専用] Channel プロパティは、パフォーマンス情報のインジェクションレベル (タイムスタンプをインジェクトするかどうか) を決定します。	Channel
		requestTimeout : int チャンネルに対するデフォルト要求タイムアウト（秒単位）へのアクセスを提供します。	Channel
		uri : String このチャンネルに対するエンドポイント URI 全体を作成するのに使用される URI へのアクセスを提供します。	Channel

プロテクトプロパティ

	プロパティ		定義元
		shouldBeConnected : Boolean [読み取り専用] このチャンネルをエンドポイントに接続する必要があるかどうかを示します。	Channel

パブリックメソッド

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

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

	メソッド		定義元
		Channel(id:String = null, uri:String = null) 指定されたエンドポイント URI に接続する汎用チャンネルのインスタンスを作成します。	Channel
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		applySettings(settings:XML):void 個々のチャンネルに必要な設定を適用するには常に、サブクラスでこのメソッドをオーバーライドする必要があります。	Channel
		connect(channelSet:ChannelSet):void ChannelSet をチャンネルに接続します。	Channel
		disconnect(channelSet:ChannelSet):void ChannelSet をチャンネルから切断します。	Channel
		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 チャンネルが接続されていれば、CommandMessage をサーバーに送信してログアウトします。	Channel
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		send(agent:MessageAgent, message:IMessage):void 指定されたメッセージをターゲットの宛先に送信します。	Channel
		setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void 資格情報を指定の値に設定します。	Channel
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

	メソッド		定義元
		applyClientLoadBalancingSettings(props:XML):void クライアントのロードバランシング URL が存在する場合はそれらの URL を適用します。	Channel
		connectFailed(event:ChannelFaultEvent):void 失敗した内部接続を処理し、チャンネルの FAULT イベントを送出します。	Channel
		connectSuccess():void 成功した内部接続を処理し、チャンネルの CONNECT イベントを送出します。	Channel
		connectTimeoutHandler(event:flash.events:TimerEvent):void ChannelFaultEvent を送出して接続タイムアウトを処理します。	Channel
		disconnectFailed(event:ChannelFaultEvent):void 失敗した内部切断を処理し、チャンネルの FAULT イベントを送出します。	Channel
		disconnectSuccess(rejected:Boolean = false):void 成功した内部切断を処理して、チャンネルの DISCONNECT イベントを送出します。	Channel
		flexClientWaitHandler(event:PropertyChangeEvent):void アプリケーションへの初回チャンネル接続を管理するためのガード条件への変更を処理します。	Channel
		getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder チャンネルの send() メソッドに適切な MessageResponder を返します。	Channel
		internalConnect():void チャンネルをエンドポイントに接続します。	Channel
		internalDisconnect(rejected:Boolean = false):void チャンネルをエンドポイントから切断します。	Channel
		internalSend(messageResponder:MessageResponder):void チャンネルを通じてメッセージを送信し、応答を応答側に転送します。	Channel

イベント

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

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

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

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
channelConnect	チャンネルがエンドポイントから切断された後で送出されます。	Channel
channelDisconnect	チャンネルがエンドポイントから切断された後で送出されます。	Channel
channelFault	チャンネルに障害が発生した後に送出されます。	Channel
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
message	チャンネルがエンドポイントからメッセージを受信したときに送出されます。	Channel
propertyChange	チャンネルのプロパティが変更されたときに送出されます。	Channel

プロテクト定数

	定数		定義元
		CONNECT_TIMEOUT_SECONDS : String = "connect-timeout-seconds" [静的]	Channel
		ENABLE_SMALL_MESSAGES : String = "enable-small-messages" [静的]	Channel
		FALSE : String = "false" [静的]	Channel
		RECORD_MESSAGE_SIZES : String = "record-message-sizes" [静的]	Channel
		RECORD_MESSAGE_TIMES : String = "record-message-times" [静的]	Channel
		REQUEST_TIMEOUT_SECONDS : String = "request-timeout-seconds" [静的]	Channel
		SERIALIZATION : String = "serialization" [静的]	Channel
		TRUE : String = "true" [静的]	Channel

プロパティの詳細

authenticated

プロパティ

authenticated:Boolean [読み取り専用]

このチャンネルを認証するかどうかを示します。

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

実装
public function get authenticated():Boolean

endpoint

プロパティ

endpoint:String [読み取り専用]

このチャンネルのエンドポイントへのアクセスを提供します。この値は、uri プロパティの値に基づいて算出されます。

実装
public function get endpoint():String

failoverURIs

プロパティ

failoverURIs:Array

エンドポイントがクラスタ化されている場合に、このチャンネルがフェイルオーバーを試行できるエンドポイント URI のセットへのアクセスを提供します。

このプロパティは、クラスタ化が有効のときは自動的に設定されます。クラスタ化を使用しない場合は、独自の値を設定できます。

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

id

プロパティ

id:String

このチャンネルの ID へのアクセスを提供します。

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

protocol

プロパティ

protocol:String [読み取り専用]

チャンネルが使用するプロトコルへのアクセスを提供します。

メモ：チャンネルのサブクラスでこのメソッドをオーバーライドし、サポートされるプロトコルを表すストリングを返す必要があります。サポートされるプロトコルのストリングの例として、"rtmp"、"http"、"https" などがあります。

実装
public function get protocol():String

reconnecting

プロパティ

reconnecting:Boolean [読み取り専用]

このチャンネルが代替エンドポイントへの再接続を実行中であるかどうかを示します。

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

実装
public function get reconnecting():Boolean

requestTimeout

プロパティ

requestTimeout:int

チャンネルに対するデフォルト要求タイムアウト（秒単位）へのアクセスを提供します。値が 0 以下の場合は、送信要求はクライアント上でタイムアウトになりません。

要求タイムアウトは、リモート宛先からの応答を必要とする RPC スタイルのメッセージングで特に便利です。

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

shouldBeConnected

プロパティ

shouldBeConnected:Boolean [読み取り専用]

このチャンネルをエンドポイントに接続する必要があるかどうかを示します。このフラグを使用するのは、いつフェイルオーバを試みる必要があるか、および切断またはフォルト時にいつ切断通知をリモートエンドポイントに送信するかを制御する場合です。

実装
protected function get shouldBeConnected():Boolean

uri

プロパティ

uri:String

このチャンネルに対するエンドポイント URI 全体を作成するのに使用される URI へのアクセスを提供します。URI は部分パスにすることができ、その場合は必要に応じて完全なエンドポイント URI が計算されます。

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

コンストラクターの詳細

メソッドの詳細

applyClientLoadBalancingSettings

()

メソッド

protected function applyClientLoadBalancingSettings(props:XML):void

クライアントのロードバランシング URL が存在する場合はそれらの URL を適用します。クライアントのロードバランシング URL のセットから URL をランダムに選択して、チャンネルのメイン URL として設定します。次に、残りの URL をチャンネルの failoverURI として割り当てます。

パラメーター

props:XML — このチャンネルに対する services-config.xml ファイルの XML フラグメントのプロパティセクションです。

applySettings

()

メソッド

public function applySettings(settings:XML):void

個々のチャンネルに必要な設定を適用するには常に、サブクラスでこのメソッドをオーバーライドする必要があります。必ず super.applySettings() を呼び出して、チャンネルに一般的な設定を適用してください。このメソッドは、主に Channel サブクラスで使用されます。

パラメーター

settings:XML — このチャンネルの services-config.xml ファイルの XML フラグメントです。

connect

()

メソッド

public final function connect(channelSet:ChannelSet):void

ChannelSet をチャンネルに接続します。チャンネルがまだエンドポイントに接続されていない場合は、接続を試みます。チャンネルのサブクラスで internalConnect() メソッドをオーバーライドし、基になる接続が確立されたら connectSuccess() メソッドを呼び出す必要があります。

パラメーター

channelSet:ChannelSet — チャンネルに接続する ChannelSet です。

connectFailed

()

メソッド

protected function connectFailed(event:ChannelFaultEvent):void

失敗した内部接続を処理し、チャンネルの FAULT イベントを送出します。チャンネルに failoverURI 値がある場合は、その URI 値を順に使用して、接続が確立されるまでまたは使用可能な値がなくなるまで、自動的に再接続を試みます。

パラメーター

event:ChannelFaultEvent — 失敗した接続の ChannelFaultEvent です。

connectSuccess

()

メソッド

protected function connectSuccess():void

成功した内部接続を処理し、チャンネルの CONNECT イベントを送出します。

connectTimeoutHandler

()

メソッド

protected function connectTimeoutHandler(event:flash.events:TimerEvent):void

ChannelFaultEvent を送出して接続タイムアウトを処理します。現在の接続試行を停止するために、サブタイプによってオーバーライドされることがありますが、super.connectTimeoutHandler(event) を呼び出す必要があります。

パラメーター

event:flash.events:TimerEvent — 接続タイムアウト時間に達したことを示すタイマーイベントです。

disconnect

()

メソッド

public final function disconnect(channelSet:ChannelSet):void

ChannelSet をチャンネルから切断します。チャンネルがエンドポイントに接続されていて、接続されている ChannelSet がそれ以上ない場合、ChannelSet は内部的に切断されます。

チャンネルのサブクラスで internalDisconnect() メソッドをオーバーライドし、基となる接続が終了している場合は disconnectSuccess() メソッドを呼び出す必要があります。

パラメーター

channelSet:ChannelSet — チャンネルから切断する ChannelSet です。

disconnectFailed

()

メソッド

protected function disconnectFailed(event:ChannelFaultEvent):void

失敗した内部切断を処理し、チャンネルの FAULT イベントを送出します。

パラメーター

event:ChannelFaultEvent — 失敗した切断の ChannelFaultEvent です。

disconnectSuccess

()

メソッド

protected function disconnectSuccess(rejected:Boolean = false):void

成功した内部切断を処理して、チャンネルの DISCONNECT イベントを送出します。切断の原因がネットワーク障害で、チャンネルに failoverURI 値がある場合は、その URI 値を順に使用して、接続が確立されるまでまたは使用可能な値がなくなるまで、自動的に再接続を試みます。

パラメーター

rejected:Boolean (default = false) — スキップしない限り試行されるフェイルオーバー処理を切断時にすべてスキップする必要がある場合は、true です。フェイルオーバー処理の実行を許可する必要のある場合は、false です。

flexClientWaitHandler

()

メソッド

protected function flexClientWaitHandler(event:PropertyChangeEvent):void

アプリケーションへの初回チャンネル接続を管理するためのガード条件への変更を処理します。この呼び出しは、このチャンネルが接続の試行を待っている状態であることを意味します。

パラメーター

event:PropertyChangeEvent — FlexClient シングルトンにより送出された PropertyChangeEvent です。

getMessageResponder

()

メソッド

protected function getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder

チャンネルの send() メソッドに適切な MessageResponder を返します。オーバーライドする必要があります。

パラメーター

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

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

戻り値

MessageResponder — 結果またはエラーを処理するための MessageResponder です。

例外

IllegalOperationError — チャンネルのサブクラスでこのメソッドをオーバーライドしない場合。

internalConnect

()

メソッド

protected function internalConnect():void

チャンネルをエンドポイントに接続します。オーバーライドする必要があります。

internalDisconnect

()

メソッド

protected function internalDisconnect(rejected:Boolean = false):void

チャンネルをエンドポイントから切断します。オーバーライドする必要があります。

パラメーター

rejected:Boolean (default = false) — 接続拒否またはタイムアウトが原因で切断され、再接続を自動的に試行する必要がない場合は true で、それ以外の場合は false です。

internalSend

()

メソッド

protected function internalSend(messageResponder:MessageResponder):void

チャンネルを通じてメッセージを送信し、応答を応答側に転送します。オーバーライドする必要があります。

パラメーター

messageResponder:MessageResponder — 応答を処理するための MessageResponder です。

logout

()

メソッド

public function logout(agent:MessageAgent):void

チャンネルが接続されていれば、CommandMessage をサーバーに送信してログアウトします。現在の証明書はクリアされます。

パラメーター

agent:MessageAgent — ログアウトするための MessageAgent です。

send

()

メソッド

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

指定されたメッセージをターゲットの宛先に送信します。実際の送信を実行するには、サブクラスで internalSend() メソッドをオーバーライドする必要があります。

パラメーター

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

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

例外

InvalidDestinationError — MessageAgent とメッセージのいずれにも宛先が指定されていない場合。

setCredentials

()

メソッド

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

資格情報を指定の値に設定します。資格情報が null でなく、チャンネルが接続されている場合、このメソッドは資格情報を使用してログインするようにとの CommandMessage もサーバーに送信します。

パラメーター

	`credentials:String` — 資格情報はストリングです。

	`agent:MessageAgent` (default = `null`) — ログインするための MessageAgent です。ログイン結果を処理します。

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

例外

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

イベントの詳細

channelConnect

イベント

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

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

チャネルがリモート宛先に接続を試みて問題が発生すると常に、Channel およびそのサブクラスは Channel.Connect.Failed コードを発行します。AMFChannel オブジェクトは、既に接続されているチャネルが基になる NetConnection から Call.Failed コードを受け取ると、Channel.Call.Failed コードを発行します。

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

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

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

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

定数の詳細

CONNECT_TIMEOUT_SECONDS

定数

protected static const CONNECT_TIMEOUT_SECONDS:String = "connect-timeout-seconds"

ENABLE_SMALL_MESSAGES

定数

protected static const ENABLE_SMALL_MESSAGES:String = "enable-small-messages"

FALSE

定数

protected static const FALSE:String = "false"

RECORD_MESSAGE_SIZES

定数

protected static const RECORD_MESSAGE_SIZES:String = "record-message-sizes"

RECORD_MESSAGE_TIMES

定数

protected static const RECORD_MESSAGE_TIMES:String = "record-message-times"

REQUEST_TIMEOUT_SECONDS

定数

protected static const REQUEST_TIMEOUT_SECONDS:String = "request-timeout-seconds"

SERIALIZATION

定数

protected static const SERIALIZATION:String = "serialization"

TRUE

定数

protected static const TRUE:String = "true"

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

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

	`id:String` (default = `null`) — このチャンネルの ID です。

	`uri:String` (default = `null`) — このチャンネルのエンドポイント URI です。

Channel - AS3 BlazeDS LCDS

パッケージx

言語エレメント

付録

パッケージ mx.messaging

authenticated

channelSets

connected

connectTimeout

endpoint

failoverURIs

id

protocol

reconnecting

recordMessageSizes

recordMessageTimes

requestTimeout

shouldBeConnected

uri

applyClientLoadBalancingSettings

applySettings

connect

connectFailed

connectSuccess

connectTimeoutHandler

disconnect

disconnectFailed

disconnectSuccess

flexClientWaitHandler

getMessageResponder

internalConnect

internalDisconnect

internalSend

logout

send

setCredentials

channelConnect

channelDisconnect

channelFault

message

propertyChange

CONNECT_TIMEOUT_SECONDS

ENABLE_SMALL_MESSAGES

FALSE

RECORD_MESSAGE_SIZES

RECORD_MESSAGE_TIMES

REQUEST_TIMEOUT_SECONDS

SERIALIZATION

TRUE