blob: dad273426ecbce6a327ee4c6c22a0c4e3161fe12 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<apiPackage id="mx.netmon"><apiName>mx.netmon</apiName><apiDetail/><apiClassifier id="mx.netmon:NetworkMonitor"><apiName>NetworkMonitor</apiName><shortdesc>
NetworkMonitor は、Flash Builder Network Monitor 機能に情報を送信するために、フレームワークとエンタープライズサービスクラスが使用するスタブです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseClassifier>Object</apiBaseClassifier></apiClassifierDef><apiDesc>
NetworkMonitor は、Flash Builder Network Monitor 機能に情報を送信するために、フレームワークとエンタープライズサービスクラスが使用するスタブです。Flash Builder に備わっているミクスインクラスが記入する多数の Impl 関数を NetworkMonitor が宣言します。これらの関数を割り当てない場合、スタブは何も行わず、適宜、false または null を返します。現時点では、モニターを呼び出すコードを簡単にするためにシングルトンまたはインスタンスオブジェクトを使用しません。
</apiDesc></apiClassifierDetail><apiOperation id="mx.netmon:NetworkMonitor:adjustNetConnectionURL"><apiName>adjustNetConnectionURL</apiName><shortdesc>
モニターを通過するように、NetConnectionChannel および HTTPChannel の要求の URL を調整します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="String"/></apiReturn><apiParam><apiItemName>rootUrl</apiItemName><apiType value="String"/><apiDesc>調整する対象です。
</apiDesc></apiParam><apiParam><apiItemName>url</apiItemName><apiType value="String"/></apiParam></apiOperationDef><apiDesc>
モニターを通過するように、NetConnectionChannel および HTTPChannel の要求の URL を調整します。変更後の URL を返します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:adjustURLRequest"><apiName>adjustURLRequest</apiName><shortdesc>
モニターを通過するように URLRequest を調整します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>urlRequest</apiItemName><apiType value="flash.net:URLRequest"/><apiDesc>調整する URLRequest です。(相対 URL がサポートされます。)
</apiDesc></apiParam><apiParam><apiItemName>rootURL</apiItemName><apiType value="String"/><apiDesc>相対 URL から絶対 URL を計算します。必要に応じて、SWF ファイルの URL をこの値として渡します。
</apiDesc></apiParam><apiParam><apiItemName>correlationID</apiItemName><apiType value="String"/><apiDesc>関連イベントに使用される correlationID です。
</apiDesc></apiParam></apiOperationDef><apiDesc>
モニターを通過するように URLRequest を調整します。モニターに送信される URLRequest には 2 つのヘッダーがあります。
<ul>
<li><codeph>actualHostPort</codeph>:URL の実際の <codeph>host:port</codeph> です。</li>
<li><codeph>correlationID</codeph>:メッセージングからの場合、要求の correlationID です(Image/Loader 要求は独自の correlationID を作成する必要があります)。</li>
</ul>
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:isMonitoring"><apiName>isMonitoring</apiName><shortdesc>
モニターがリンクおよび監視する場合は true を返します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="Boolean"/></apiReturn></apiOperationDef><apiDesc>
モニターがリンクおよび監視する場合は true を返します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:monitorEvent"><apiName>monitorEvent</apiName><shortdesc>
イベントが発生したことをモニターに通知します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>event</apiItemName><apiType value="flash.events:Event"/><apiDesc>発生する(または発生した)イベントです。
</apiDesc></apiParam><apiParam><apiItemName>correlationID</apiItemName><apiType value="String"/><apiDesc>他のイベントまたは要求と関連する correlationID です。
</apiDesc></apiParam></apiOperationDef><apiDesc>
イベントが発生したことをモニターに通知します。Loader はこれを使用してセキュリティおよび IO エラーを監視できます。Loader の <codeph>complete</codeph> イベントには使用しないでください。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:monitorFault"><apiName>monitorFault</apiName><shortdesc>
フォルトが発生したことをモニターに通知します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>faultMessage</apiItemName><apiType value="Object"/><apiDesc>返されたメッセージです。結果を示します。呼び出しの失敗による場合は、null になります。(依存関係におけるリンクを避けるため、ここでは型指定されません。)
</apiDesc></apiParam><apiParam><apiItemName>actualFault</apiItemName><apiType value="Object"/><apiDesc>失敗が発生しました。(依存関係におけるリンクを避けるため、ここでは型指定されません。)
</apiDesc></apiParam></apiOperationDef><apiDesc>
フォルトが発生したことをモニターに通知します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:monitorInvocation"><apiName>monitorInvocation</apiName><shortdesc>
呼び出しが発生していることをモニターに通知します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>id</apiItemName><apiType value="String"/><apiDesc>確認できた場合に、呼び出しを発生させるタグの ID です。
</apiDesc></apiParam><apiParam><apiItemName>invocationMessage</apiItemName><apiType value="Object"/><apiDesc>有線で送信されるメッセージです。(依存関係におけるリンクを避けるため、ここでは型指定されません。)
</apiDesc></apiParam><apiParam><apiItemName>messageAgent</apiItemName><apiType value="Object"/></apiParam></apiOperationDef><apiDesc>
呼び出しが発生していることをモニターに通知します。
</apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.netmon:NetworkMonitor:monitorResult"><apiName>monitorResult</apiName><shortdesc>
結果が戻ったことをモニターに通知します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiStatic/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>resultMessage</apiItemName><apiType value="Object"/><apiDesc>返されたメッセージです。結果を示します。(依存関係におけるリンクを避けるため、ここでは型指定されません。)
</apiDesc></apiParam><apiParam><apiItemName>actualResult</apiItemName><apiType value="Object"/><apiDesc>デコードされた結果です。
</apiDesc></apiParam></apiOperationDef><apiDesc>
結果が戻ったことをモニターに通知します。
</apiDesc></apiOperationDetail></apiOperation><apiValue id="mx.netmon:NetworkMonitor:adjustNetConnectionURLImpl"><apiName>adjustNetConnectionURLImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:adjustURLRequestImpl"><apiName>adjustURLRequestImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:isMonitoringImpl"><apiName>isMonitoringImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:monitorEventImpl"><apiName>monitorEventImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:monitorFaultImpl"><apiName>monitorFaultImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:monitorInvocationImpl"><apiName>monitorInvocationImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue><apiValue id="mx.netmon:NetworkMonitor:monitorResultImpl"><apiName>monitorResultImpl</apiName><shortdesc>
ミクスインによって割り当てられます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiStatic/><apiType value="Function"/></apiValueDef><apiDesc>
ミクスインによって割り当てられます。
</apiDesc></apiValueDetail></apiValue></apiClassifier></apiPackage>