Syntax
enum class PartyNetworkStatistic
{
AverageRelayServerRoundTripLatencyInMilliseconds = 0,
SentProtocolPackets = 1,
SentProtocolBytes = 2,
RetriedProtocolPackets = 3,
RetriedProtocolBytes = 4,
DroppedProtocolPackets = 5,
ReceivedProtocolPackets = 6,
ReceivedProtocolBytes = 7,
CurrentlyQueuedSendMessages = 8,
CurrentlyQueuedSendMessageBytes = 9,
CurrentlyActiveSendMessages = 10,
CurrentlyActiveSendMessageBytes = 11,
TimedOutSendMessages = 12,
TimedOutSendMessageBytes = 13,
CanceledSendMessages = 14,
CanceledSendMessageBytes = 15,
}
Constants
| Constant | Description |
|---|---|
| AverageRelayServerRoundTripLatencyInMilliseconds | 到网络的云中继服务器的当前往返延迟移动平均值(“ping 时间”),以毫秒为单位。 此延迟表示本地设备当前发送消息并从透明云中继服务器接收响应所需时间的移动平均值。 也可以通过使用 PartyLocalEndpoint::GetEndpointStatistics() 检索 PartyEndpointStatistic::AverageDeviceRoundTripLatencyInMilliseconds 统计信息,来确定特定本地终结点到网络中另一终结点的平均往返延迟。 |
| SentProtocolPackets | 作为此网络的一部分,曾传输到远程设备的内部协议数据包总数。 此统计信息表示由本地设备出于任何网络原因传输的内部协议数据包总数。它包括因 PartyLocalEndpoint::SendMessage() 调用而生成的数据包,但不一定与它们一一对应,因为多个小消息可能合并到单个数据包中,或者根据配置和环境因素,一个大消息可能被分段成多个数据包。此外,即使没有显式的 PartyLocalEndpoint::SendMessage() 调用,数据包也可能代表应用程序承载聊天或其他内部库功能(例如 API 操作支持消息、协议确认或重试)。 此统计信息不包括为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作而生成的任何数据包。 |
| SentProtocolBytes | 作为此网络的一部分,曾传输到远程设备的内部协议字节总数。 此统计信息表示由本地设备出于任何网络原因传输的内部协议数据包中的字节总数。此大小包括 PartyLocalEndpoint::SendMessage() 有效负载及其内部协议开销,以及代表应用程序所需的任何聊天或其他内部库功能(例如 API 操作支持消息、协议确认或重试),即使没有显式的 PartyLocalEndpoint::SendMessage() 调用。 报告的值不包括 Internet 协议(例如 UDP、IP)的数据包开销,也不包括 Party 库内部协议运行所依赖的低层媒介的开销。 此统计信息不包括为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作而生成的任何数据包的大小。 |
| RetriedProtocolPackets | 作为此网络的一部分,曾重新传输到远程设备的内部协议数据包总数。 此统计信息表示本地设备由于早前尝试明显环境丢失而进行的内部协议数据包重传总数。Party 库仅会重试丢失的、包含使用 PartySendMessageOptions::GuaranteedDelivery 发送的应用程序消息的数据包或具有类似传递要求的内部库消息。 此统计信息不包括为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作而生成的数据包的任何重试。 |
| RetriedProtocolBytes | 作为此网络的一部分,曾重新传输到远程设备的内部协议字节总数。 此统计信息表示本地设备由于早前尝试明显环境丢失而进行的内部协议数据包重传中的字节总数。此大小包括使用 PartySendMessageOptions::GuaranteedDelivery 发送的应用程序消息的有效负载或具有类似传递要求的内部库消息的有效负载。 报告的值不包括 Internet 协议(例如 UDP、IP)的重试数据包开销,也不包括 Party 库内部协议运行所依赖的低层媒介的开销。 此统计信息不包括为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作而生成的任何重试数据包的大小。 |
| DroppedProtocolPackets | 认为已丢失的、此网络中发往远程设备的内部协议数据包总数。 此统计信息表示由本地设备尝试传输但似乎遭受环境丢失的内部协议数据包总数。它们可能被或未被重试(请参见 RetriedProtocolPackets)。 此统计信息不包括为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作而生成的任何已丢失数据包。 |
| ReceivedProtocolPackets | 作为此网络的一部分,曾从远程设备接收的内部协议数据包总数。 此统计信息表示由本地设备出于任何网络原因接收的内部协议数据包总数,与 PartyEndpointMessageReceivedStateChange 不一一对应。多个小消息可能合并到单个数据包中,或者根据配置和环境因素,一个大消息可能被分段成多个数据包。此外,即使没有显式的 PartyLocalEndpoint::SendMessage() 调用,数据包也可能代表应用程序承载聊天或其他内部库功能(例如 API 操作支持消息、协议确认或重试)。 此统计信息不包括作为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作的一部分而接收的任何数据包。 |
| ReceivedProtocolBytes | 作为此网络的一部分,曾从远程设备接收的内部协议字节总数。 此统计信息表示由本地设备出于任何网络原因接收的内部协议数据包中的字节总数。此大小包括 PartyEndpointMessageReceivedStateChange 有效负载及其内部协议开销,以及所需的任何聊天或其他内部库功能(例如 API 操作支持消息、协议确认或重试)。 报告的值不包括 Internet 协议(例如 UDP、IP)的数据包开销,也不包括 Party 库内部协议运行所依赖的低层媒介的开销。 此统计信息不包括作为 Party 库内部用于身份验证、管理事务、语音转文本转录和文本转语音合成某些方面的 HTTP Web 客户端操作的一部分而接收的任何数据包的大小。 |
| CurrentlyQueuedSendMessages | 当前由 PartyLocalEndpoint::SendMessage() 加入队列但尚未从所有本地终结点传输到网络中所有远程终结点的消息数量。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息只会被计数一次,而不会按每个目标终结点分别计数。 |
| CurrentlyQueuedSendMessageBytes | 当前由 PartyLocalEndpoint::SendMessage() 加入队列但尚未从所有本地终结点传输到网络中所有远程终结点的消息中数据的字节数。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息的字节数只会被计数一次,而不会按每个目标终结点分别计数。 |
| CurrentlyActiveSendMessages | 从所有本地终结点发送到网络中所有远程终结点、当前正在传输或仍有更多本地状态更改待处理的 PartyLocalEndpoint::SendMessage() 消息数量。 一旦消息的第一个字节被放入正在传输的数据包中,该消息就被视为”活动”。它保持活动状态,直到传输完成并且其本地 PartyDataBuffersReturnedStateChange(如适用)已返回给 PartyManager::FinishProcessingStateChanges()。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息只会被计数一次,而不会按每个目标终结点分别计数。 |
| CurrentlyActiveSendMessageBytes | 从所有本地终结点发送到网络中所有远程终结点、当前正在传输或仍有更多本地状态更改待处理的 PartyLocalEndpoint::SendMessage() 消息中数据的字节数。 一旦消息的第一个字节被放入正在传输的数据包中,该消息就被视为”活动”。它保持活动状态,直到传输完成并且其本地 PartyDataBuffersReturnedStateChange(如适用)已返回给 PartyManager::FinishProcessingStateChanges()。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息的字节数只会被计数一次,而不会按每个目标终结点分别计数。 |
| TimedOutSendMessages | 从所有本地终结点发送到网络中所有远程终结点、因超过其发送队列超时时间而在未传输的情况下曾被丢弃的 PartyLocalEndpoint::SendMessage() 消息总数。 调用 PartyLocalEndpoint::SendMessage() 时,使用 PartySendMessageQueuingConfiguration::timeoutInMillseconds 指定消息的发送队列超时时间。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息只会被计数一次,而不会按每个目标终结点分别计数。 |
| TimedOutSendMessageBytes | 从所有本地终结点发送到网络中所有远程终结点、因超过其发送队列超时时间而在未传输的情况下曾被丢弃的 PartyLocalEndpoint::SendMessage() 消息中数据的总字节数。 调用 PartyLocalEndpoint::SendMessage() 时,使用 PartySendMessageQueuingConfiguration::timeoutInMillseconds 指定消息的发送队列超时时间。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息的字节数只会被计数一次,而不会按每个目标终结点分别计数。 |
| CanceledSendMessages | 从所有本地终结点发送到网络中所有远程终结点、曾被取消的 PartyLocalEndpoint::SendMessage() 消息总数。 应用程序在传输消息之前通过调用带有匹配筛选表达式的 PartyLocalEndpoint::CancelMessages() 取消消息。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息只会被计数一次,而不会按每个目标终结点分别计数。 |
| CanceledSendMessageBytes | 从所有本地终结点发送到网络中所有远程终结点、曾被取消的 PartyLocalEndpoint::SendMessage() 消息中数据的总字节数。 应用程序在传输消息之前通过调用带有匹配筛选表达式的 PartyLocalEndpoint::CancelMessages() 取消消息。 出于效率考虑,当通过透明云中继服务器一次向多个目标终结点发送时,PartyLocalEndpoint::SendMessage() 仅将单个消息加入队列。此类消息的字节数只会被计数一次,而不会按每个目标终结点分别计数。 |
Requirements
Header: Party.hSee also
Party membersPartyEndpointStatistic
PartySendMessageOptions
PartyNetwork::GetNetworkStatistics
PartyLocalEndpoint::SendMessage
PartyLocalEndpoint::GetEndpointStatistics
