PartyLocalEndpoint::GetEndpointStatistics

Artikel
07/11/2023

Ruft einen oder mehrere Statistikindikatorwerte für die angegebenen Zielendpunkte ab.

Syntax

PartyError GetEndpointStatistics(  
    uint32_t targetEndpointCount,  
    PartyEndpointArray targetEndpoints,  
    uint32_t statisticCount,  
    const PartyEndpointStatistic* statisticTypes,  
    uint64_t* statisticValues  
)

Parameter

targetEndpointCount uint32_t

Die Anzahl der Zielendpunkte im targetEndpoints Array. Kann 0 sein, um Statistiken für alle Endpunkte abzurufen, die sich derzeit im Netzwerk befinden, einschließlich dieses lokalen Endpunkts.

targetEndpoints PartyEndpointArray
Eingabearray der Größe targetEndpointCount

Das targetEndpointCount Einstiegsarray von PartyEndpoint-Zielobjektzeigern, für die Statistiken abgerufen werden sollen. Dies wird ignoriert, wenn targetEndpointCount null ist.

statisticCount uint32_t

Die Anzahl der Statistiken im Eingabearray statisticTypes und die in das statisticValues Ausgabearray geschrieben werden sollen. Dies muss mindestens 1 sein.

statisticTypes PartyEndpointStatistic*
Eingabearray der Größe statisticCount

Das statisticCount Eingabearray eindeutiger PartyEndpointStatistic-Typen, die abgerufen werden sollen.

statisticValues uint64_t*
Ausgabearray der Größe statisticCount

Das statisticCount Eingabeausgabearray, in das die Statistikwerte geschrieben werden sollen. Jeder Statistikwert wird an demselben Eintragsindex geschrieben, der dem entspricht, wo die angeforderte PartyEndpointStatistic im statisticTypes Eingabearray angezeigt wird.

Rückgabewert

PartyError

c_partyErrorSuccess , wenn das Abrufen der Endpunktstatistiken erfolgreich war, andernfalls ein Fehlercode. Die lesbare Form des Fehlercodes kann über PartyManager::GetErrorMessage() abgerufen werden.

Hinweise

Diese Methode wird verwendet, um Leistungsindikatoren, Warteschlangenlängen, historische Nutzungsmetriken oder andere statistische Informationen abzurufen, die zwischen diesem lokalen Endpunkt und einem Zielendpunkt aufgezeichnet wurden.

Alternativ können mehrere Zielendpunkte oder ein Nulleingabearray bereitgestellt werden, um Statistiken für alle Derzeit im Netzwerk befindlichen Zielendpunkte abzurufen, einschließlich dieses lokalen Endpunkts. Wenn mehrere Zielendpunkte angefordert werden, sind die zurückgegebenen Werte die kombinierte Statistik für diese Endpunkte. Die spezielle Methode, die zum Kombinieren mehrerer Endpunktstatistiken in einem einzelnen Wert verwendet wird, hängt vom jeweiligen PartyEndpointStatistic-Typ ab und wird durch diesen beschrieben.

Ein bestimmter PartyEndpointStatistic-Typ kann in beliebiger Reihenfolge im statisticTypes Array angezeigt werden, darf aber nicht mehrmals angegeben werden. Jeder entsprechende Statistikwert wird in der gleichen Reihenfolge in das statisticValues Array geschrieben.

Die zurückgegebenen Statistikwerte sind immer die aktuellsten verfügbaren Werte. Es gibt keine Garantie, dass sie denselben Wert von einem GetEndpointStatistics()-Aufruf an den nächsten melden, auch wenn keine dazwischen liegenden Aufrufe von PartyManager::StartProcessingStateChanges() oder PartyManager::FinishProcessingStateChanges() vorhanden sind.

Voraussetzungen

Header: Party.h

Weitere Informationen

PartyLocalEndpoint
PartyEndpointStatistic
PartyNetwork::GetNetworkStatistics

Freigeben über