次の方法で共有

PartyLocalEndpoint::GetEndpointStatistics

  • [アーティクル]

指定したターゲット エンドポイントの 1 つ以上の統計カウンター値を取得します。

構文

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

パラメーター

targetEndpointCount uint32_t

targetEndpoints 配列内のターゲット エンドポイントの数。 このローカル エンドポイントを含め、現在ネットワーク内のすべてのエンドポイントの統計情報を取得するには、0 がよい可能性があります。

targetEndpoints PartyEndpointArray
サイズ targetEndpointCount の入力配列

統計を取得する対象の PartyEndpoint オブジェクト ポインターの targetEndpointCount エントリ配列。 これは、targetEndpointCount がゼロの場合は無視されます。

statisticCount uint32_t

入力statisticTypes配列内の統計の数とstatisticValues出力配列に書き込まれる統計の数。 値は 1 以上である必要があります。

statisticTypes PartyEndpointStatistic*
サイズ statisticCount の入力配列

取得する一意の PartyEndpointStatistic 型の statisticCount エントリ入力配列。

statisticValues uint64_t*
サイズ statisticCount の出力配列

統計値を書き込む statisticCount エントリ出力配列。 各統計値は、要求された PartyEndpointStatistic が statisticTypes 入力配列に出現する場所に対応する同じエントリ インデックスに書き込まれます。

戻り値

PartyError

c_partyErrorSuccessエンドポイント統計の取得が成功した場合、またはエラー コード。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。

解説

このメソッドは、パフォーマンス カウンター、キューの長さ、使用状況の履歴メトリック、またはこのローカル エンドポイントとターゲット エンドポイントの間で記録されたその他の統計情報を取得するために使用されます。

または、複数のターゲット エンドポイントを指定することも、ゼロエントリ配列を指定して、このローカル エンドポイントを含め、ネットワーク内に現在存在するすべてのターゲット エンドポイントの統計情報を取得することもできます。 複数のターゲット エンドポイントが要求された場合、返される値は、それらのエンドポイントの結合された統計になります。 複数のエンドポイント統計を 1 つの値に結合するために使用される特定のメソッドは、特定の PartyEndpointStatistic 型に依存し、それによって記述されます。

指定された PartyEndpointStatistic 型は、 statisticTypes 配列内の任意の順序で指定できますが、複数回指定することはできません。 対応する各統計値は、同じ順序で statisticValues 配列に書き込まれます。

返される統計値は、常に利用可能な最新の統計値です。 PartyManager::StartProcessingStateChanges()またはまたはPartyManager::FinishProcessingStateChanges()への間に干渉する呼び出しがない場合でも、1 つの GetEndpointStatistics() 呼び出しから次の GetEndpointStatistics() 呼び出しに対して同じ値が報告される保証はありません。

要件

ヘッダー: Party.h

関連項目

PartyLocalEndpoint
PartyEndpointStatistic
PartyNetwork::GetNetworkStatistics