mx.messaging.channels.AMFChannel （Flex 3.2）

（BlazeDS のみ）

パッケージ	mx.messaging.channels
クラス	public class AMFChannel
継承	AMFChannel NetConnectionChannel PollingChannel Channel EventDispatcher Object
サブクラス	SecureAMFChannel, StreamingAMFChannel

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

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

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

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

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

パブリックプロパティ

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

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

	プロパティ		定義元
		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
		netConnection : NetConnection [読み取り専用] このチャンネルに関連付けられた NetConnection へのアクセスを提供します。	NetConnectionChannel
		piggybackingEnabled : Boolean 未処理のポーリングが進行中でないときに、このチャンネルがポーリング要求と通常の送信要求を一緒に送るかどうかを示します。	AMFChannel
		polling : Boolean [読み取り専用] チャンネルがアクティブにポーリングしているかどうかを報告します。	AMFChannel
		pollingEnabled : Boolean このチャンネルでポーリングが有効であるかどうかを示します。	AMFChannel
		pollingInterval : Number このチャンネルのポーリング間隔へのアクセスを提供します。	AMFChannel
		protocol : String [override] [読み取り専用] このチャンネルのプロトコル（http）を返します。	AMFChannel
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		reconnecting : Boolean [読み取り専用] このチャンネルが代替エンドポイントへの再接続を実行中であるかどうかを示します。	Channel
		recordMessageSizes : Boolean [読み取り専用] Channel プロパティは、パフォーマンス情報のインジェクションレベル (メッセージのサイズをインジェクトするかどうか) を決定します。	Channel
		recordMessageTimes : Boolean [読み取り専用] Channel プロパティは、パフォーマンス情報のインジェクションレベル (タイムスタンプをインジェクトするかどうか) を決定します。	Channel
		requestTimeout : int チャンネルに対するデフォルト要求タイムアウト（秒単位）へのアクセスを提供します。	Channel
		uri : String このチャンネルに対するエンドポイント URI 全体を作成するのに使用される URI へのアクセスを提供します。	Channel

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

パブリックメソッド

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

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

	メソッド		定義元
		AMFChannel(id:String = null, uri:String = null) 新しい 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 [override] 指定されたメッセージをターゲットの宛先に送信します。	PollingChannel
		setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void 資格情報を指定の値に設定します。	Channel
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

継承されるプロテクトメソッドを表示

	メソッド		定義元
		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
		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

プロパティの詳細

piggybackingEnabled

プロパティ

piggybackingEnabled:Boolean

未処理のポーリングが進行中でないときに、このチャンネルがポーリング要求と通常の送信要求を一緒に送るかどうかを示します。これにより、サーバーはクライアント向けのデータとクライアントのメッセージへの応答を一緒に送ることができます。

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

polling

プロパティ

polling:Boolean [読み取り専用]

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

実装
public function get polling():Boolean

pollingEnabled

プロパティ

pollingEnabled:Boolean

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

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

pollingInterval

プロパティ

pollingInterval:Number

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

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

例外

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

protocol

プロパティ

protocol:String [読み取り専用] [override]

このチャンネルのプロトコル（http）を返します。

実装
override public function get protocol():String

コンストラクタの詳細

AMFChannel

()

コンストラクタ

public function AMFChannel(id:String = null, uri:String = null)

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

パラメータ

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

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

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/messaging/channels/AMFChannel.html

Adobe® Flex™ 3.2 リファレンスガイド This Help system only	すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレームフレームなし
AMFChannel	プロパティ \| メソッド \| イベント