XboxLiveQualityOfServiceMeasurement Класс

Определение

Пространство имен:

Windows.Networking.XboxLive

Описывает рабочие параметры измерения качества обслуживания сети (QoS) и предоставляет доступ к результатам таких измерений.

Важно!

Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих 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 доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.

Свойства

DeviceAddresses	Возвращает список адресов для проверки. Содержимое списка можно изменить с помощью методов интерфейса IVector . Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
IsSystemInboundBandwidthConstrained	Возвращает или задает логическое значение, указывающее, пытаются ли измерения качества обслуживания (QoS) и другие внутренние сетевые операции Windows.Networking.XboxLive ограничить потребление входящей пропускной способности. Ограничение потребления таким образом снижает влияние этих операций на использование входящей пропускной способности приложения за счет более длительных задержек или увеличения частоты сбоев для них. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
IsSystemOutboundBandwidthConstrained	Возвращает или задает логическое значение, указывающее, пытаются ли измерения качества обслуживания (QoS) и другие внутренние сетевые операции Windows.Networking.XboxLive ограничить потребление исходящей пропускной способности. Ограничение потребления таким образом снижает влияние этих операций на исходящее использование пропускной способности приложения за счет более длительных задержек или увеличения частоты сбоев для них. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
MaxPrivatePayloadSize	Статическое свойство, которое получает максимальное число байтов, разрешенное для частных буферов полезных данных. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
MaxSimultaneousProbeConnections	Статическое свойство, которое получает или задает максимальное количество одновременных подключений пробы измерения. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
MetricResults	Возвращает список всех метрик для всех устройств, указанных в текущем измерении качества обслуживания (QoS). Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
Metrics	Возвращает список метрик, которые будут измеряться в этом измерении качества обслуживания (QoS). Список можно изменить с помощью методов интерфейса IVector . Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
NumberOfProbesToAttempt	Возвращает или задает количество проб для каждого устройства при выполнении этого измерения качества обслуживания (QoS). Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
NumberOfResultsPending	Возвращает количество ожидающих результатов для текущего измерения качества обслуживания (QoS) во время выполнения. Если действие измерения завершено, равно 0. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
PrivatePayloadResults	Возвращает список частных полезных данных, которые были получены в этом измерении качества обслуживания (QoS). Обратите внимание, что частные полезные данные извлекаются только в том случае, если свойству ShouldRequestPrivatePayloads присвоено значение true до вызова MeasureAsync . Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API во время выполнения завершатся ошибкой.
PublishedPrivatePayload	Возвращает или задает частные полезные данные, опубликованные для локального устройства. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API во время выполнения завершатся ошибкой.
ShouldRequestPrivatePayloads	Возвращает или задает логическое значение, указывающее, следует ли извлекать частные полезные данные с устройств, участвующих в этом измерении качества обслуживания (QoS). Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API во время выполнения завершатся ошибкой.
TimeoutInMilliseconds	Возвращает или задает время ожидания для этого измерения качества обслуживания (QoS). Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API во время выполнения завершатся ошибкой.

Методы

ClearPrivatePayload()	Очищает частные полезные данные, установленные с помощью PublishPrivatePayloadBytes. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
GetMetricResult(XboxLiveDeviceAddress, XboxLiveQualityOfServiceMetric)	Возвращает результаты последнего измерения заданной метрики при подключении к заданному адресу. В коде указывается набор метрик, адресов устройств, времени ожидания и количества проб, а затем вызывается XboxLiveQualityOfServiceMeasurement.MeasureAsync , чтобы начать выполнение указанных измерений. Вы можете вызвать Метод GetMetricResult в любое время во время выполнения измерений или после их завершения и получить его текущее значение. Обратите внимание, что при многократном вызове GetMetricResult для заданной метрики во время выполнения соответствующих измерений вы можете получить разные значения по мере выполнения измерения. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
GetMetricResultsForDevice(XboxLiveDeviceAddress)	Возвращает все результаты метрик для данного устройства. В коде указывается набор метрик, адресов устройств, времени ожидания и количества проб, а затем вызывается XboxLiveQualityOfServiceMeasurement.MeasureAsync , чтобы начать выполнение указанных измерений. Метод GetMetricResultsForDevice можно вызвать в любое время во время выполнения измерений или после их завершения и получить текущие значения. Обратите внимание, что если вы неоднократно вызываете GetMetricResultsForDevice и проверяете заданную метрику во время выполнения соответствующих измерений, вы можете получить разные значения по мере продолжения измерения. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric)	Возвращает самые последние значения данной метрики на всех измеряемых устройствах. В коде указывается набор метрик, адресов устройств, времени ожидания и количества проб, а затем вызывается XboxLiveQualityOfServiceMeasurement.MeasureAsync , чтобы начать выполнение указанных измерений. Метод GetMetricResultsForMetric можно вызвать в любое время во время выполнения измерений или после их завершения и получить текущие значения. Обратите внимание, что если вы неоднократно вызываете GetMetricResultsForMetric. и проверить заданную метрику для конкретного устройства, пока выполняются соответствующие измерения, вы можете получить различные значения по мере продолжения измерения. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
GetPrivatePayloadResult(XboxLiveDeviceAddress)	Возвращает частные полезные данные для измеряемого устройства, если для этого измерения было задано значение trueShouldRequestPrivatePayloads. В коде указывается набор метрик, адресов устройств, времени ожидания, количества проб и запроса частных полезных данных, а затем вызывается xboxLiveQualityOfServiceMeasurement.MeasureAsync для начала выполнения указанных измерений и получения любых частных полезных данных. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
MeasureAsync()	Инициирует измерения качества обслуживания (QoS) в соответствии со свойствами данного экземпляра. Код может получить текущие результаты измерения сразу после вызова этого метода до завершения всех измерений. Полученные метрики могут измениться в любое время, пока еще выполняется измерение. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API будут завершаться ошибкой во время выполнения.
PublishPrivatePayloadBytes(Byte[])	Задает частные полезные данные, возвращаемые, когда удаленный узел запрашивает частные полезные данные. Важно! Этот API доступен не для всех приложений. Если ваша учетная запись разработчика не специально подготовлена корпорацией Майкрософт, вызовы этих API во время выполнения завершатся ошибкой.