| パッケージ | flash.profiler |
| クラス | public final class Telemetry |
| 継承 | Telemetry  Object |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 11.4, AIR 3.4 |
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| connected : Boolean [静的] [読み取り専用]
Telemetry がサーバーに接続されているかどうかを示します。
| Telemetry | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| spanMarker : Number [静的] [読み取り専用]
Telemetry.sendSpanMetric で使用するマーカーを返します。
| Telemetry | ||
| メソッド | 定義元 | ||
|---|---|---|---|
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
[静的]
ソケット経由でコマンドを発行することで呼び出せる関数を登録します。登録が成功すると、true を返します。 | Telemetry | ||
[静的]
Telemetry からカスタムメトリックを要求します。 | Telemetry | ||
[静的]
Telemetry からカスタムスパンメトリックを要求します。Telemetry.spanMarker を使用して、プロファイルされる関数の開始のマーカーを取得し、関数の最後に、そのマーカーを使用して Telemetry.sendSpanMetric を呼び出します。 | Telemetry | ||
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
[静的] | Telemetry | ||
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
connected | プロパティ |
spanMarker | プロパティ |
registerCommandHandler | () | メソッド |
public static function registerCommandHandler(commandName:String, handler:Function):Boolean| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 11.4, AIR 3.4 |
ソケット経由でコマンドを発行することで呼び出せる関数を登録します。
登録が成功すると true を返します。登録が失敗する場合は、指定したコマンドに対して既にハンドラーが登録されています（または、コマンド名の先頭がピリオドになっています。そのような名前はプレーヤー内部用に予約されています）。前もって unregisterCommandHandler を使用すれば、登録済みのハンドラーを解除して新しいハンドラーを登録可能にすることができます。
ハンドラー関数の戻り値は、コマンドの結果として送信されます（tlm-response.result）。ハンドラーでエラー応答を返す必要があるときは、Error をスローすることができます。この場合、Error.message および Error.id はそれぞれ tlm-response.tlm-error.message およびtlm-response.tlm-error.code として送信されます。（tlm-response.result および tlm-response.tlm-error.data は null として送信されます）
パラメーター
commandName:String — 一意の名前を指定するストリングです（ソケット経由のコマンドはメソッド名としてこのストリングを指定する必要があります）。ガイドラインでは、逆 DNS 表記法に従うように指示されており、これは名前空間の競合を回避するのに役立ちます。さらに、.（ピリオド）で始まる名前は、ネイティブ使用のために予約されています。
| |
handler:Function — functionId 引数に指定された、コマンドがメソッド名を使用してソケット経由で Telemetry によって受信されると呼び出される関数です。ハンドラーは、（Telemetry Protocol の tlm-method.params で定義された）配列型の 1 つの引数のみを受け付ける必要があり、Telemetry サーバーによってメソッド名と共に送信される必要があります。
|
Boolean |
sendMetric | () | メソッド |
public static function sendMetric(metric:String, value:*):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 11.4, AIR 3.4 |
Telemetry からカスタムメトリックを要求します。メトリック名およびオブジェクトは、Telemetry プロトコルフォーマットによって送信されます。
カスタムメトリック名前空間のガイドラインでは、逆 DNS 表記法に従うように指示されており、これは名前空間の競合を回避するのに役立ちます。
パラメーター
metric:String — メトリック名
| |
value:* — メトリックの詳細情報を含んだ任意のプリミティブ値またはオブジェクト
|
例外
ArgumentError — メトリックが Flash のネイティブの名前空間（例えば、メトリック名が「.」で始まる）のように予約済みの名前空間をしている場合
|
sendSpanMetric | () | メソッド |
public static function sendSpanMetric(metric:String, startSpanMarker:Number, value:* = null):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 11.4, AIR 3.4 |
Telemetry からカスタムスパンメトリックを要求します。
Telemetry.spanMarker を使用して、プロファイルされる関数の開始のマーカーを取得し、関数の最後に、そのマーカーを使用して Telemetry.sendSpanMetric を呼び出します。Telemetry は、関数の名前、開始マーカー、および継続時間に加えてオプションの値を、Telemetry プロトコルによって送信します。
カスタムメトリック名前空間のガイドラインでは、逆 DNS 表記法に従うように指示されており、これは名前空間の競合を回避するのに役立ちます。
指定したしきい値未満の継続時間のスパンメトリックは、Telemetry Server から Telemetry Protocol を使用して制御できますが、Telemetry に無視されます（Telemetry Server に送信されません）。
パラメーター
metric:String — メトリック名
| |
startSpanMarker:Number — 開始マーカー
| |
value:* (default = null) |
例外
ArgumentError — Flash ネイティブ名前空間などの予約済み名前空間がメトリック内で使用されている（メトリック名の先頭がピリオドになっている）場合
|
関連する API エレメント
unregisterCommandHandler | () | メソッド |
Tue Jun 12 2018, 10:34 AM Z