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

(Adobe^® Flex™ Data Services 2 のみ)

パッケージ	mx.messaging.channels
	public class AMFChannel
継承	AMFChannel NetConnectionChannel PollingChannel Channel EventDispatcher Object
Subclasses	SecureAMFChannel

AMFChannel クラスは、メッセージング用の基本的な AMF サポートを提供します。このチャネルは、サーバープッシュにほぼ応じた間隔でサーバーをポーリングするように設定することができます。ポーリングを無効にした状態でこのチャネルを使用すると、リモート宛先に RPC メッセージを送信してリモート宛先のメソッドを呼び出すことができます。

AMFChannel は Flash Player に備わっているネットワークサービスに依存し、NetConnection クラスによって ActionScript に公開されます。このチャネルでは NetConnection が排他的に使用され、インスタンスごとに新しい NetConnection が作成されます。

チャネルは、ServerConfig.getChannel() メソッドによってフレームワク内で作成されます。必要に応じて、チャネルを直接作成し、ChannelSet に割り当てることができます。

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

このチャネルをポーリングモードで使用すると、設定ファイル内の polling-interval-seconds プロパティに基づいて、サーバーに対する新しいメッセージのポーリングが行われます。この動作は、pollingInterval プロパティを設定すると変更できます。デフォルト値は 3 秒です。ポーリングを有効にするには、チャネルを接続して、設定ファイル内の polling-enabled プロパティを true に設定するか、チャネルの pollingEnabled プロパティを true に設定する必要があります。

パブリックプロパティ

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

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

	プロパティ		定義
		channelSets : Array チャネルに接続された ChannelSet へのアクセスを提供します。	Channel
		connected : Boolean このチャネルがリモート宛先との接続を確立しているかどうかを示します。	Channel
		connectTimeout : int チャネルに対する接続タイムアウト時間 (秒単位) へのアクセスを提供します。	Channel
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		endpoint : String このチャネルのエンドポイントへのアクセスを提供します。	Channel
		failoverURIs : Array エンドポイントがクラスタ化されている場合に、このチャネルがフェイルオーバーを試行できるエンドポイント URI のセットへのアクセスを提供します。	Channel
		id : String このチャネルの ID へのアクセスを提供します。	Channel
		netConnection : NetConnection このチャネルに関連付けられた NetConnection へのアクセスを提供します。	NetConnectionChannel
		polling : Boolean [read-only] チャネルがアクティブにポーリングしているかどうかを報告します。	AMFChannel
		pollingEnabled : Boolean このチャネルでポーリングが可能であるかどうかを示します。	AMFChannel
		pollingInterval : Number このチャネルのポーリング間隔へのアクセスを提供します。	AMFChannel
		protocol : String [read-only] このチャネルのプロトコル (http) を返します。	AMFChannel
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		reconnecting : Boolean このチャネルが代替エンドポイントへの再接続を実行中であるかどうかを示します。	Channel
		requestTimeout : int チャネルに対するデフォルト要求タイムアウト (秒単位) へのアクセスを提供します。	Channel
		uri : String このチャネルに対するエンドポイント URI 全体を作成するのに使用される URI へのアクセスを提供します。	Channel

パブリック Methods

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

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

	メソッド		定義
		AMFChannel(id:String, uri:String) 新しい AMFChannel インスタンスを作成します。	AMFChannel
		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
		disablePolling():void `enablePolling()` および `disablePolling()` が呼び出された回数に基づいてポーリングを無効にします。	PollingChannel
		disconnect(channelSet:ChannelSet):void ChannelSet をチャネルから切断します。	Channel
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		enablePolling():void `enablePolling()` および `disablePolling()` が呼び出された回数に基づいてポーリングを有効にします。	PollingChannel
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指定されたプロパティがオブジェクトに定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		logout(agent:MessageAgent):void チャネルが接続されていれば、CommandMessage をサーバーに送信してログアウトします。	Channel
		poll():void このチャネルにサブスクライブしているコンシューマが存在し、このチャネルでポーリングが有効な場合に、ポーリング処理を開始します。	PollingChannel
		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):void 資格情報を指定の値に設定します。	Channel
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

Protected Methods

継承される Protected メソッドの表示

	メソッド		定義
		connectFailed(event:ChannelFaultEvent):void 失敗した内部接続を処理し、チャネルの `FAULT` イベントを送出します。	Channel
		connectSuccess():void 成功した内部接続を処理し、チャネルの `CONNECT` イベントを送出します。	Channel
		connectTimeoutHandler(event:TimerEvent):void ChannelFaultEvent を送出して接続タイムアウトを処理します。	Channel
		disconnectFailed(event:ChannelFaultEvent):void 失敗した内部切断を処理し、チャネルの `FAULT` イベントを送出します。	Channel
		disconnectSuccess(rejected:Boolean = false):void 成功した内部切断を処理して、チャネルの `DISCONNECT` イベントを送出します。	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 がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
channelConnect	チャネルがエンドポイントから切断された後で送出されます。	Channel
channelDisconnect	チャネルがエンドポイントから切断された後で送出されます。	Channel
channelFault	チャネルに障害が発生した後に送出されます。	Channel
deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
message	チャネルがエンドポイントからメッセージを受信したときに送出されます。	Channel
propertyChange	チャネルのプロパティが変更されたときに送出されます。	Channel

プロパティの詳細

polling

プロパティ

polling:Boolean [read-only]

チャネルがアクティブにポーリングしているかどうかを報告します。

実装
public function get polling():Boolean

pollingEnabled

プロパティ

pollingEnabled:Boolean [read-write]

このチャネルでポーリングが可能であるかどうかを示します。

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

pollingInterval

プロパティ

pollingInterval:Number [read-write]

このチャネルのポーリング間隔へのアクセスを提供します。値はミリ秒単位です。この値は、サーバープッシュに合わせて、このチャネルがサーバーにメッセージを要求する頻度を決定します。

実装
public function get pollingInterval():Number
public function set pollingInterval(value:Number):void

Throws

ArgumentError — pollingInterval に 0 以下の値が割り当てられている場合。

protocol

プロパティ

protocol:String [read-only]

このチャネルのプロトコル (http) を返します。

実装
public function get protocol():String

コンストラクタの詳細

AMFChannel

()

コンストラクタ

public 関数 AMFChannel(id:String, uri:String)

新しい AMFChannel インスタンスを作成します。

パラメータ

	`id:String` — このチャネルの ID です。

	`uri:String` — このチャネルの URI です。

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