PartyLocalEndpoint::GetEndpointStatistics

为指定目标终结点获取一个或多个统计信息计数器值。

语法

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() 检索错误代码的可读形式。

备注

此方法用于检索性能计数器、队列长度、历史使用指标，或在此本地终结点和目标终结点之间记录的其他统计信息。

或者，可以有多个目标终结点，用于检索当前网络中所有目标终结点统计信息的零条目数组，包括此本地终结点。 如果请求多个目标终结点，则返回的值是这些终结点合并后的统计信息。 用于将多个终结点统计信息合并为单个值的特定方法，取决于特定 PartyEndpointStatistic 类型并进行了描述。

给定的 PartyEndpointStatistic 类型可以在 statisticTypes 数组中以任何顺序出现，但不得多次指定。 按相同的顺序将每个相应的统计值写入 statisticValues 数组中。

返回的统计信息值始终为最新可用统计信息。 不能保证它们从一个GetEndpointStatistics()调用报告相同的值到下一个调用，即使中间没有调用PartyManager::StartProcessingStateChanges()或PartyManager::FinishProcessingStateChanges() 。

要求

标题： Party.h

另请参阅

PartyLocalEndpoint
PartyEndpointStatistic
PartyNetwork::GetNetworkStatistics