包 | 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.message
和 Error.id
将分别作为 tlm-response.tlm-error.message
和 tlm-response.tlm-error.code
发送。(tlm-response.result
和 tlm-response.tlm-error.data
将作为空值发送)
参数
commandName:String — 用于指定唯一名称的字符串(通过套接字的命令应将此字符串指定为方法名称)。指导方针是遵循反向 DNS 表示法,这有助于避免命名空间冲突。此外,以 . 开头的名称保留供本机使用。
| |
handler:Function — 当 Telemetry 通过套接字收到具有方法名称(在 functionId 参数中指定)的命令时要调用的函数。处理程序只应接受类型数组的一个参数(如 Telemetry 协议中的 tlm-method.params 所定义),该参数必须由 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 协议从 Telemetry 服务器进行控制)的持续时间的范围量度将被 Telemetry 忽略(不会发送到 Telemetry 服务器)。
参数
metric:String — 量度名称
| |
startSpanMarker:Number — 开始标记。
| |
value:* (default = null ) — 可选参数。将与名称、标记和持续时间一起发送的原始值/对象
|
引发
ArgumentError — 如果量度使用保留的命名空间,例如 Flash 本机命名空间(即,如果量度名称以“.”开头)
|
相关 API 元素
unregisterCommandHandler | () | 方法 |
Tue Jun 12 2018, 11:04 AM Z