Share via

XboxLiveQualityOfServiceMeasurement Class

  • Reference

Definition

Namespace:
Windows.Networking.XboxLive
Edit

Describes the operating parameters of a network Quality of Service (QoS) measurement, and provides access to the results of such measurements.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public ref class XboxLiveQualityOfServiceMeasurement sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Networking.XboxLive.XboxLiveSecureSocketsContract)]
/// [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)]
class XboxLiveQualityOfServiceMeasurement final
/// [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.Activatable(65536, typeof(Windows.Networking.XboxLive.XboxLiveSecureSocketsContract))]
[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)]
public sealed class XboxLiveQualityOfServiceMeasurement
[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
Inheritance
Object Platform::Object IInspectable XboxLiveQualityOfServiceMeasurement
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Xbox One System Apps Extensions for the UWP (introduced in 10.0.0.1)
 Xbox Live Extension SDK (introduced in 10.0.10240.0)
 Xbox One Extensions for the UWP (introduced in 10.0.10240.0)
 Windows Desktop Extension SDK (introduced in 10.0.16299.0)
API contract
Windows.Networking.XboxLive.XboxLiveSecureSocketsContract (introduced in v1.0)

Constructors

XboxLiveQualityOfServiceMeasurement()

Creates an XboxLiveQualityOfServiceMeasurement object.

To perform a Quality of Service (QoS) measurement, create an instance of this class, then set the parameters of the measurement using the DeviceAddresses, Metrics, NumberOfProbesToAttempt, ShouldRequestPrivatePayloads, and TimeoutInMilliseconds members. Then call MeasureAsync to initiate measurements. You can query results while the measurement is in progress, or you can wait until the operation finishes, and then query final results.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Properties

DeviceAddresses

Gets the list of addresses to probe. The contents of the list can be changed using IVector interface methods.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsSystemInboundBandwidthConstrained

Gets or sets a Boolean value that configures whether Quality of Service (QoS) measurements and other Windows.Networking.XboxLive internal network operations attempt to constrain their inbound bandwidth consumption. Constraining consumption in this way reduces the impact of those operations on your app's inbound bandwidth usage, at the expense of longer delays or increased failure rates for them.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
IsSystemOutboundBandwidthConstrained

Gets or sets a Boolean value configuring whether Quality of Service (QoS) measurements and other Windows.Networking.XboxLive internal network operations attempt to constrain their outbound bandwidth consumption. Constraining consumption in this way reduces the impact of those operations on your app's outgoing bandwidth usage, at the expense of longer delays or increased failure rates for them.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MaxPrivatePayloadSize

Static property that gets the maximum number of bytes permitted for private payload buffers.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MaxSimultaneousProbeConnections

Static property that gets or sets the maximum number of simultaneous measurement probe connections.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MetricResults

Gets a list of all metrics for all devices specified in the current Quality of Service (QoS) measurement.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
Metrics

Gets the list of the metrics to be measured in this Quality of Service (QoS) measurement. You can modify the list using IVector interface methods.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
NumberOfProbesToAttempt

Gets or sets the number of probes to attempt to each device while performing this Quality of Service (QoS) measurement.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
NumberOfResultsPending

Gets the number of pending results for the current Quality of Service (QoS) measurement while it is in progress. It is 0 if the measurement action has completed.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
PrivatePayloadResults

Gets a list of private payloads that have been retrieved in this Quality of Service (QoS) measurement.

Note that private payloads are retrieved only when the ShouldRequestPrivatePayloads property is set to true before MeasureAsync is called.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
PublishedPrivatePayload

Gets or sets the private payload published for the local device.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
ShouldRequestPrivatePayloads

Gets or sets a Boolean value indicating whether private payloads should be retrieved from the devices involved in this Quality of Service (QoS) measurement.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
TimeoutInMilliseconds

Gets or sets the timeout for this Quality of Service (QoS) measurement.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Methods

ClearPrivatePayload()

Clears the private payload established with PublishPrivatePayloadBytes.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
GetMetricResult(XboxLiveDeviceAddress, XboxLiveQualityOfServiceMetric)

Gets the results of the most recent measurement of a given metric on the connection to a given address.

Your code specifies a set of metrics, device addresses, timeouts, and number of probes to attempt, and then calls XboxLiveQualityOfServiceMeasurement.MeasureAsync to begin making the specified measurements. You can call GetMetricResult at any time while measurements are in progress or after they have finished, and retrieve its current value. Note that if you repeatedly call GetMetricResult for a given metric while the relevant measurements are in progress, you might get different values as the measurement proceeds.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
GetMetricResultsForDevice(XboxLiveDeviceAddress)

Gets all metric results for a given device.

Your code specifies a set of metrics, device addresses, timeouts, and number of probes to attempt, and then calls XboxLiveQualityOfServiceMeasurement.MeasureAsync to begin making the specified measurements. You can call GetMetricResultsForDevice at any time while measurements are in progress or after they have finished, and retrieve current values. Note that if you repeatedly call GetMetricResultsForDevice, and inspect a given metric while the relevant measurements are in progress, you might get different values as the measurement proceeds.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric)

Gets the most recent values of a given metric, across all devices being measured.

Your code specifies a set of metrics, device addresses, timeouts, and number of probes to attempt, and then calls XboxLiveQualityOfServiceMeasurement.MeasureAsync to begin making the specified measurements. You can call GetMetricResultsForMetric at any time while measurements are in progress or after they have finished, and retrieve current values. Note that if you repeatedly call GetMetricResultsForMetric. and inspect a given metric for a particular device while the relevant measurements are in progress, you might get different values as the measurement proceeds.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
GetPrivatePayloadResult(XboxLiveDeviceAddress)

Gets the private payload for a device currently being measured, if ShouldRequestPrivatePayloads was set to true for this measurement.

Your code specifies a set of metrics, device addresses, timeouts, number of probes to attempt, and whether to request private payloads, and then calls XboxLiveQualityOfServiceMeasurement.MeasureAsync to begin making the specified measurements, and to retrieve any private payloads.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
MeasureAsync()

Initiates Quality of Service (QoS) measurements as specified by the properties of this instance.

Your code can retrieve current measurement results as soon as this method has been called, before all measurements have been completed. The metrics you retrieve can change at any time as long as a measurement is still in progress.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.
PublishPrivatePayloadBytes(Byte[])

Sets the private payload that's returned when a remote host queries for the private payload.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Applies to