XboxLiveQualityOfServiceMeasurement 类

定义

命名空间:

Windows.Networking.XboxLive

描述网络服务质量 (QoS) 度量的操作参数，并提供对此类度量结果的访问。

重要

此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。

public ref class XboxLiveQualityOfServiceMeasurement sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Networking.XboxLive.XboxLiveSecureSocketsContract")]
class XboxLiveQualityOfServiceMeasurement final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Networking.XboxLive.XboxLiveSecureSocketsContract")]
public sealed class XboxLiveQualityOfServiceMeasurement

function XboxLiveQualityOfServiceMeasurement()

Public NotInheritable Class XboxLiveQualityOfServiceMeasurement

继承

Object Platform::Object IInspectable XboxLiveQualityOfServiceMeasurement

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

设备系列	Xbox One System Apps Extensions for the UWP (在 10.0.0.1 中引入) Xbox Live Extension SDK (在 10.0.10240.0 中引入) Xbox One Extensions for the UWP (在 10.0.10240.0 中引入) Windows Desktop Extension SDK (在 10.0.16299.0 中引入)
API contract	Windows.Networking.XboxLive.XboxLiveSecureSocketsContract (在 v1.0 中引入)

构造函数

XboxLiveQualityOfServiceMeasurement()

创建 XboxLiveQualityOfServiceMeasurement 对象。 若要执行服务质量 (QoS) 度量，请创建此类的实例，然后使用 DeviceAddresses、 Metrics、 NumberOfProbesToAttempt、 ShouldRequestPrivatePayloads 和 TimeoutInMilliseconds 成员设置度量的参数。 然后调用 MeasureAsync 以启动度量。 可以在度量正在进行时查询结果，也可以等到操作完成，然后查询最终结果。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。

属性

DeviceAddresses	获取要探测的地址列表。 可以使用 IVector 接口方法更改列表的内容。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
IsSystemInboundBandwidthConstrained	获取或设置一个布尔值，该值配置服务质量是否 (QoS) 度量值和其他 Windows.Networking.XboxLive 内部网络操作尝试限制其入站带宽消耗。 以这种方式限制使用量可降低这些操作对应用的入站带宽使用量的影响，代价是延迟时间更长或失败率增加。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
IsSystemOutboundBandwidthConstrained	获取或设置一个布尔值，该值配置服务质量是否 (QoS) 度量值和其他 Windows.Networking.XboxLive 内部网络操作尝试限制其出站带宽消耗。 以这种方式限制使用量可减少这些操作对应用的传出带宽使用量的影响，代价是延迟时间更长或失败率增加。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
MaxPrivatePayloadSize	静态属性，用于获取专用有效负载缓冲区允许的最大字节数。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
MaxSimultaneousProbeConnections	静态属性，用于获取或设置同时测量探测连接的最大数目。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
MetricResults	获取当前服务质量 (QoS) 度量中指定的所有设备的所有指标的列表。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
Metrics	获取要在此服务质量 (QoS) 度量中度量的指标列表。 可以使用 IVector 接口方法修改列表。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
NumberOfProbesToAttempt	获取或设置在执行此服务质量 (QoS) 度量时尝试每个设备的探测数。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
NumberOfResultsPending	获取正在进行的当前服务质量 (QoS) 度量的挂起结果数。 如果测量操作已完成，则为 0。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
PrivatePayloadResults	获取在此服务质量 (QoS) 度量中检索的专用有效负载的列表。 请注意，只有在调用 MeasureAsync 之前，ShouldRequestPrivatePayloads 属性设置为 true 时，才会检索专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
PublishedPrivatePayload	获取或设置为本地设备发布的专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
ShouldRequestPrivatePayloads	获取或设置一个布尔值，该值指示是否应从此服务质量 (QoS) 度量的设备检索专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
TimeoutInMilliseconds	获取或设置此服务质量 (QoS) 度量的超时。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。

方法

ClearPrivatePayload()	清除使用 PublishPrivatePayloadBytes 建立的专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
GetMetricResult(XboxLiveDeviceAddress, XboxLiveQualityOfServiceMetric)	获取与给定地址的连接上给定指标的最新度量的结果。 代码指定一组指标、设备地址、超时和要尝试的探测数，然后调用 XboxLiveQualityOfServiceMeasurement.MeasureAsync 开始进行指定的度量。 可以在测量正在进行时或测量完成后随时调用 GetMetricResult ，并检索其当前值。 请注意，如果在相关度量正在进行时重复调用给定指标的 GetMetricResult ，则可能在度量进行时获得不同的值。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
GetMetricResultsForDevice(XboxLiveDeviceAddress)	获取给定设备的所有指标结果。 代码指定一组指标、设备地址、超时和要尝试的探测数，然后调用 XboxLiveQualityOfServiceMeasurement.MeasureAsync 开始进行指定的度量。 可以在测量正在进行时或测量完成后随时调用 GetMetricResultsForDevice ，并检索当前值。 请注意，如果反复调用 GetMetricResultsForDevice，并在相关度量正在进行时检查给定指标，则在度量进行时可能会得到不同的值。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric)	获取所测量的所有设备中给定指标的最新值。 代码指定一组指标、设备地址、超时和要尝试的探测数，然后调用 XboxLiveQualityOfServiceMeasurement.MeasureAsync 开始进行指定的度量。 可以在测量正在进行时或测量完成后随时调用 GetMetricResultsForMetric ，并检索当前值。 请注意，如果重复调用 GetMetricResultsForMetric。 在进行相关测量时，检查特定设备的给定指标，在测量过程中可能会得到不同的值。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
GetPrivatePayloadResult(XboxLiveDeviceAddress)	如果为此度量将 ShouldRequestPrivatePayloads 设置为 true ，则获取当前正在测量的设备专用有效负载。 代码指定一组指标、设备地址、超时、要尝试的探测数以及是否请求专用有效负载，然后调用 XboxLiveQualityOfServiceMeasurement.MeasureAsync 开始进行指定的度量，并检索任何专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
MeasureAsync()	启动服务质量 (QoS) 由此实例的属性指定的度量值。 在完成所有度量之前，代码可以在调用此方法后立即检索当前度量结果。 只要度量仍在进行中，检索的指标可以随时更改。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。
PublishPrivatePayloadBytes(Byte[])	设置远程主机查询专用有效负载时返回的专用有效负载。 重要 此 API 并非适用于所有应用。 除非你的开发人员帐户由 Microsoft 专门预配，否则对这些 API 的调用将在运行时失败。