QualityOfService.MeasureQualityOfServiceAsync Method

Measures a set of Quality of Service (QoS) metrics between the local host and the list of remote hosts passed in, by sending and recieving packets and measuring the results. The remote hosts must be other Xbox consoles or Xbox Live Compute SDK servers that are referenced by a SecureDeviceAddress.

Syntax

public:
static IAsyncOperation<MeasureQualityOfServiceResult^ >^ MeasureQualityOfServiceAsync(
         IIterable<SecureDeviceAddress^ >^ addresses,
         IIterable<QualityOfServiceMetric>^ metrics,
         uint32 timeoutInMilliseconds,
         uint32 numberOfProbes
)

Parameters

addresses
Type: IIterable<SecureDeviceAddress^ >

A list of remote addresses to probe. The recommended number of addresses to probe is 32 or less. A count larger than 32 is accepted; but the larger the count, the longer the QoS lookup takes.

metrics
Type: IIterable<QualityOfServiceMetric>

A list of metrics to request from the remote consoles.

timeoutInMilliseconds
Type: uint32

Sets the maximum amount of time, in milliseconds, that the system waits to hear back from all remote hosts. If all hosts have not responded in this time, the system will complete the measurement operation with the results it has.

numberOfProbes
Type: uint32

Number of desired probe replies to receive. Each probe sends two 100-byte packets to the host, and receives two 100-byte packets in return. If the desired number of probe replies is not received, the QoS client sends more probes. The larger the number of probes, the longer the QoS lookup takes. The recommended value for numberOfProbes is 8. To test whether the remote host is active, the title can set numberOfProbes to 0.

Return value

Type: IAsyncOperation<MeasureQualityOfServiceResult^ >

An IAsyncOperation that references the asynchronous measurement result.

Remarks

Note MeasureQualityOfServiceAsync should not overlap with a call to CreateAssociationAsync for the same SecureDeviceAddress. Both asynchronous operations should be performed sequentially.

Requirements

Namespace: Windows.Xbox.Networking

Metadata: windows.winmd