Syntaxe
Paramètres
targetEndpointCount uint32_t
Le nombre de points de terminaison cibles dans le tableau targetEndpoints. Peut être 0 pour récupérer les statistiques de tous les points de terminaison actuellement présents dans le réseau, y compris celui-ci, qui est local.
targetEndpoints PartyEndpointArrayinput array of size
targetEndpointCount
Le tableau de targetEndpointCount entrées de pointeurs vers les objets PartyEndpoint cibles pour lesquels les statistiques doivent être récupérées. Il est ignoré lorsque targetEndpointCount vaut zéro.
statisticCount uint32_t
Le nombre de statistiques dans le tableau d’entrée statisticTypes et à écrire dans le tableau de sortie statisticValues. Il doit être au moins égal à 1.
statisticTypes PartyEndpointStatistic*input array of size
statisticCount
Le tableau d’entrée de statisticCount entrées des types PartyEndpointStatistic uniques à récupérer.
statisticValues uint64_t*output array of size
statisticCount
Le tableau de sortie de statisticCount entrées dans lequel les valeurs statistiques doivent être écrites. Chaque valeur statistique est écrite au même index d’entrée que celui où le PartyEndpointStatistic demandé apparaît dans le tableau d’entrée statisticTypes.
Valeur de retour
PartyErrorc_partyErrorSuccess si la récupération des statistiques des points de terminaison a réussi; sinon, un code d’erreur. La forme lisible du code d’erreur peut être obtenue au moyen de PartyManager::GetErrorMessage().
Remarques
Cette méthode permet de récupérer les compteurs de performances, les longueurs de file d’attente, les métriques d’utilisation historiques ou d’autres informations statistiques enregistrées entre ce point de terminaison local et un point de terminaison cible.Il est également possible de fournir plusieurs points de terminaison cibles, ou un tableau sans entrée pour récupérer les statistiques de tous les points de terminaison cibles actuellement présents dans le réseau, y compris celui-ci, qui est local. Si plusieurs points de terminaison cibles sont demandés, les valeurs retournées sont les statistiques combinées de ces points de terminaison. La méthode utilisée pour combiner les statistiques de plusieurs points de terminaison en une seule valeur dépend du type PartyEndpointStatistic spécifique et est décrite par celui-ci.
Un type PartyEndpointStatistic donné peut apparaître dans n’importe quel ordre dans le tableau
statisticTypes, mais ne doit pas être spécifié plus d’une fois. Chaque valeur statistique correspondante est écrite dans le tableau statisticValues dans le même ordre. Les valeurs statistiques retournées sont toujours les plus récentes disponibles. Rien ne garantit qu’elles indiqueront la même valeur d’un appel à GetEndpointStatistics() à l’autre, même en l’absence d’appels intermédiaires à PartyManager::StartProcessingStateChanges() ou PartyManager::FinishProcessingStateChanges().
Configuration requise
En-tête : Party.hVoir aussi
PartyLocalEndpointPartyEndpointStatistic
PartyNetwork::GetNetworkStatistics