Partager via


XboxLiveQualityOfServiceMeasurement Classe

Définition

Décrit les paramètres de fonctionnement d’une mesure de qualité de service (QoS) réseau et fournit l’accès aux résultats de ces mesures.

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

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
Héritage
Object Platform::Object IInspectable XboxLiveQualityOfServiceMeasurement
Attributs

Configuration requise pour Windows

Famille d’appareils
Xbox One System Apps Extensions for the UWP (introduit dans 10.0.0.1)
Xbox Live Extension SDK (introduit dans 10.0.10240.0)
Xbox One Extensions for the UWP (introduit dans 10.0.10240.0)
Windows Desktop Extension SDK (introduit dans 10.0.16299.0)
API contract
Windows.Networking.XboxLive.XboxLiveSecureSocketsContract (introduit dans v1.0)

Constructeurs

XboxLiveQualityOfServiceMeasurement()

Crée un objet XboxLiveQualityOfServiceMeasurement .

Pour effectuer une mesure de qualité de service (QoS), créez un instance de cette classe, puis définissez les paramètres de la mesure à l’aide des membres DeviceAddresses, Metrics, NumberOfProbesToAttempt, ShouldRequestPrivatePayloads et TimeoutInMilliseconds. Appelez ensuite MeasureAsync pour lancer des mesures. Vous pouvez interroger les résultats pendant que la mesure est en cours, ou attendre que l’opération se termine, puis interroger les résultats finaux.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

Propriétés

DeviceAddresses

Obtient la liste des adresses à sonder. Le contenu de la liste peut être modifié à l’aide des méthodes d’interface IVector .

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

IsSystemInboundBandwidthConstrained

Obtient ou définit une valeur booléenne qui configure si les mesures de qualité de service (QoS) et d’autres opérations réseau internes Windows.Networking.XboxLive tentent de limiter leur consommation de bande passante entrante. Limiter la consommation de cette façon réduit l’impact de ces opérations sur l’utilisation de la bande passante entrante de votre application, au détriment de délais plus longs ou d’une augmentation des taux d’échec pour celles-ci.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

IsSystemOutboundBandwidthConstrained

Obtient ou définit une valeur booléenne qui détermine si les mesures de qualité de service (QoS) et d’autres opérations réseau internes Windows.Networking.XboxLive tentent de limiter leur consommation de bande passante sortante. Limiter la consommation de cette façon réduit l’impact de ces opérations sur l’utilisation de la bande passante sortante de votre application, au détriment de délais plus longs ou d’une augmentation des taux d’échec pour celles-ci.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

MaxPrivatePayloadSize

Propriété statique qui obtient le nombre maximal d’octets autorisés pour les mémoires tampons de charge utile privées.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

MaxSimultaneousProbeConnections

Propriété statique qui obtient ou définit le nombre maximal de connexions de sonde de mesure simultanées.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

MetricResults

Obtient la liste de toutes les métriques pour tous les appareils spécifiés dans la mesure de qualité de service (QoS) actuelle.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

Metrics

Obtient la liste des métriques à mesurer dans cette mesure de qualité de service (QoS). Vous pouvez modifier la liste à l’aide des méthodes d’interface IVector .

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

NumberOfProbesToAttempt

Obtient ou définit le nombre de sondes à essayer sur chaque appareil lors de l’exécution de cette mesure de qualité de service (QoS).

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

NumberOfResultsPending

Obtient le nombre de résultats en attente pour la mesure de qualité de service (QoS) actuelle pendant qu’elle est en cours. Il est 0 si l’action de mesure est terminée.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

PrivatePayloadResults

Obtient une liste de charges utiles privées qui ont été récupérées dans cette mesure de qualité de service (QoS).

Notez que les charges utiles privées sont récupérées uniquement lorsque la propriété ShouldRequestPrivatePayloads est définie true sur avant l’appel de MeasureAsync .

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

PublishedPrivatePayload

Obtient ou définit la charge utile privée publiée pour l’appareil local.

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

ShouldRequestPrivatePayloads

Obtient ou définit une valeur booléenne indiquant si des charges utiles privées doivent être récupérées à partir des appareils impliqués dans cette mesure de qualité de service (QoS).

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

TimeoutInMilliseconds

Obtient ou définit le délai d’expiration de cette mesure de qualité de service (QoS).

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

Méthodes

ClearPrivatePayload()

Efface la charge utile privée établie avec PublishPrivatePayloadBytes.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

GetMetricResult(XboxLiveDeviceAddress, XboxLiveQualityOfServiceMetric)

Obtient les résultats de la mesure la plus récente d’une métrique donnée sur la connexion à une adresse donnée.

Votre code spécifie un ensemble de métriques, d’adresses d’appareil, de délais d’expiration et de nombre de sondes à tenter, puis appelle XboxLiveQualityOfServiceMeasurement.MeasureAsync pour commencer à effectuer les mesures spécifiées. Vous pouvez appeler GetMetricResult à tout moment pendant que les mesures sont en cours ou une fois qu’elles sont terminées, et récupérer sa valeur actuelle. Notez que si vous appelez à plusieurs reprises GetMetricResult pour une métrique donnée pendant que les mesures pertinentes sont en cours, vous pouvez obtenir des valeurs différentes au fur et à mesure que la mesure progresse.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

GetMetricResultsForDevice(XboxLiveDeviceAddress)

Obtient tous les résultats des métriques pour un appareil donné.

Votre code spécifie un ensemble de métriques, d’adresses d’appareil, de délais d’expiration et de nombre de sondes à tenter, puis appelle XboxLiveQualityOfServiceMeasurement.MeasureAsync pour commencer à effectuer les mesures spécifiées. Vous pouvez appeler GetMetricResultsForDevice à tout moment pendant que les mesures sont en cours ou une fois qu’elles sont terminées, et récupérer les valeurs actuelles. Notez que si vous appelez à plusieurs reprises GetMetricResultsForDevice et inspectez une métrique donnée pendant que les mesures pertinentes sont en cours, vous pouvez obtenir des valeurs différentes au fur et à mesure de la mesure.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric)

Obtient les valeurs les plus récentes d’une métrique donnée, sur tous les appareils en cours de mesure.

Votre code spécifie un ensemble de métriques, d’adresses d’appareil, de délais d’expiration et de nombre de sondes à tenter, puis appelle XboxLiveQualityOfServiceMeasurement.MeasureAsync pour commencer à effectuer les mesures spécifiées. Vous pouvez appeler GetMetricResultsForMetric à tout moment pendant que les mesures sont en cours ou une fois qu’elles sont terminées, et récupérer les valeurs actuelles. Notez que si vous appelez à plusieurs reprises GetMetricResultsForMetric. et inspectez une métrique donnée pour un appareil particulier pendant que les mesures pertinentes sont en cours, vous pouvez obtenir des valeurs différentes au fur et à mesure que la mesure progresse.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

GetPrivatePayloadResult(XboxLiveDeviceAddress)

Obtient la charge utile privée d’un appareil en cours de mesure, si ShouldRequestPrivatePayloads a été défini true sur pour cette mesure.

Votre code spécifie un ensemble de métriques, d’adresses d’appareil, de délais d’expiration, de nombre de sondes à tenter et de demander des charges utiles privées, puis appelle XboxLiveQualityOfServiceMeasurement.MeasureAsync pour commencer à effectuer les mesures spécifiées et récupérer les charges utiles privées.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

MeasureAsync()

Lance des mesures de qualité de service (QoS) comme spécifié par les propriétés de ce instance.

Votre code peut récupérer les résultats de mesure actuels dès que cette méthode a été appelée, avant que toutes les mesures soient terminées. Les métriques que vous récupérez peuvent changer à tout moment tant qu’une mesure est toujours en cours.

Important

Cette API n’est pas disponible pour toutes les applications. À moins que votre compte de développeur ne soit spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

PublishPrivatePayloadBytes(Byte[])

Définit la charge utile privée retournée lorsqu’un hôte distant interroge la charge utile privée.

Important

Cette API n’est pas disponible pour toutes les applications. Sauf si votre compte de développeur est spécialement approvisionné par Microsoft, les appels à ces API échouent au moment de l’exécution.

S’applique à