構文
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,
}
定数
| 定数 | 説明 |
|---|---|
| AverageRelayServerRoundTripLatencyInMilliseconds | ネットワークのクラウド リレー サーバーまでの現在のミリ秒単位の往復レイテンシー (“ping 時間”) の移動平均。 このレイテンシーは、このローカル デバイスがメッセージを送信し、透過的クラウド リレー サーバーから応答を受信するのに現在かかる時間の移動平均を表します。 PartyLocalEndpoint::GetEndpointStatistics() を使用して PartyEndpointStatistic::AverageDeviceRoundTripLatencyInMilliseconds 統計を取得することで、特定のローカル エンドポイントからネットワーク内の別のエンドポイントへの平均往復レイテンシーも判別できます。 |
| SentProtocolPackets | このネットワークの一部としてリモート デバイスに送信された内部プロトコル パケットの合計数。 この統計は、任意のネットワーク上の理由でローカル デバイスによって送信された内部プロトコル パケットの合計数を表します。PartyLocalEndpoint::SendMessage() 呼び出しの結果として生成されたパケットが含まれますが、複数の小さなメッセージが 1 つのパケットに結合される場合や、構成と環境要因に応じて大きなメッセージが複数のパケットに分割される場合があるため、必ずしも 1 対 1 の対応関係があるわけではありません。さらに、パケットは明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしに、アプリケーションのためにチャットまたはその他の内部ライブラリ機能 (例: API 操作サポート メッセージ、プロトコルの確認応答または再試行) を運ぶために使用される場合があります。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作用に生成されたパケットは含まれません。 |
| SentProtocolBytes | このネットワークの一部としてリモート デバイスに送信された内部プロトコル バイトの合計数。 この統計は、任意のネットワーク上の理由でローカル デバイスによって送信された内部プロトコル パケット内のバイトの合計数を表します。このサイズには PartyLocalEndpoint::SendMessage() ペイロードだけでなく、その内部プロトコル オーバーヘッド、および明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしにアプリケーションのために必要なチャットまたはその他の内部ライブラリ機能 (例: API 操作サポート メッセージ、プロトコルの確認応答または再試行) も含まれます。 報告される値には、インターネット プロトコル (例: UDP、IP) のパケット オーバーヘッドや、Party ライブラリの内部プロトコルが動作する下位レベルのメディアのパケット オーバーヘッドは含まれません。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作用に生成されたパケットのサイズは含まれません。 |
| RetriedProtocolPackets | このネットワークの一部としてリモート デバイスに再送信された内部プロトコル パケットの合計数。 この統計は、以前の試行が環境的に失われたと見られるためローカル デバイスによって行われた内部プロトコル パケットの再送信の合計数を表します。Party ライブラリは、PartySendMessageOptions::GuaranteedDelivery で送信されたアプリケーション メッセージ、または同様の配信要件を持つ内部ライブラリ メッセージを含む失われたパケットのみを再試行します。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作用に生成されたパケットの再試行は含まれません。 |
| RetriedProtocolBytes | このネットワークの一部としてリモート デバイスに再送信された内部プロトコル バイトの合計数。 この統計は、以前の試行が環境的に失われたと見られるためローカル デバイスによって行われた内部プロトコル パケットの再送信のバイトの合計数を表します。このサイズには、PartySendMessageOptions::GuaranteedDelivery で送信されたアプリケーション メッセージ、または同様の配信要件を持つ内部ライブラリ メッセージのペイロードが含まれます。 報告される値には、インターネット プロトコル (例: UDP、IP) の再送信されたパケット オーバーヘッドや、Party ライブラリの内部プロトコルが動作する下位レベルのメディアのパケット オーバーヘッドは含まれません。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作用に生成された再試行パケットのサイズは含まれません。 |
| DroppedProtocolPackets | このネットワーク内のリモート デバイスへの内部プロトコル パケットのうち、ドロップされたと考えられるものの合計数。 この統計は、ローカル デバイスによって試みられたが環境的な損失があったように見える内部プロトコル パケット送信の合計数を表します。それらは再試行された場合とそうでない場合があります (RetriedProtocolPackets を参照)。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作用に生成されたドロップされたパケットは含まれません。 |
| ReceivedProtocolPackets | このネットワークの一部としてリモート デバイスから受信された内部プロトコル パケットの合計数。 この統計は、任意のネットワーク上の理由でローカル デバイスによって受信された内部プロトコル パケットの合計数を表しますが、PartyEndpointMessageReceivedStateChange と 1 対 1 の対応関係はありません。複数の小さなメッセージが 1 つのパケットに結合される場合や、構成と環境要因に応じて大きなメッセージが複数のパケットに分割される場合があります。さらに、パケットは明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしに、アプリケーションのためにチャットまたはその他の内部ライブラリ機能 (例: API 操作サポート メッセージ、プロトコルの確認応答または再試行) を運ぶために使用される場合があります。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作の一部として受信されたパケットは含まれません。 |
| ReceivedProtocolBytes | このネットワークの一部としてリモート デバイスから受信された内部プロトコル バイトの合計数。 この統計は、任意のネットワーク上の理由でローカル デバイスによって受信された内部プロトコル パケット内のバイトの合計数を表します。このサイズには PartyEndpointMessageReceivedStateChange ペイロードだけでなく、その内部プロトコル オーバーヘッド、および必要なチャットまたはその他の内部ライブラリ機能 (例: API 操作サポート メッセージ、プロトコルの確認応答または再試行) も含まれます。 報告される値には、インターネット プロトコル (例: UDP、IP) のパケット オーバーヘッドや、Party ライブラリの内部プロトコルが動作する下位レベルのメディアのパケット オーバーヘッドは含まれません。 この統計には、認証、管理トランザクション、音声からテキストへの変換、およびテキストから音声への合成の一部の側面で Party ライブラリによって内部的に使用される HTTP Web クライアント操作の一部として受信されたパケットのサイズは含まれません。 |
| CurrentlyQueuedSendMessages | PartyLocalEndpoint::SendMessage() によって現在キューに入っているが、ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントにまだ送信されていないメッセージの数。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyQueuedSendMessageBytes | PartyLocalEndpoint::SendMessage() によって現在キューに入っているが、ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントにまだ送信されていないメッセージ内のデータのバイト数。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyActiveSendMessages | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中またはまだ処理すべきローカル状態変更が残っているものの数。 メッセージは、その最初のバイトが送信中のパケットに配置された時点で “アクティブ” とみなされます。送信が完了し、それに対応するローカル PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に返されるまでアクティブのままです。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyActiveSendMessageBytes | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中またはまだ処理すべきローカル状態変更が残っているもの内のデータのバイト数。 メッセージは、その最初のバイトが送信中のパケットに配置された時点で “アクティブ” とみなされます。送信が完了し、それに対応するローカル PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に返されるまでアクティブのままです。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| TimedOutSendMessages | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信されずに送信キュー タイムアウトを超えたために破棄されたメッセージの合計数。 メッセージの送信キュー タイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出すときに PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| TimedOutSendMessageBytes | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信されずに送信キュー タイムアウトを超えたために破棄されたメッセージ内のデータのバイト数の合計。 メッセージの送信キュー タイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出すときに PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CanceledSendMessages | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、キャンセルされたメッセージの合計数。 メッセージは、アプリケーションが一致するフィルター式で PartyLocalEndpoint::CancelMessages() を呼び出すことによって、送信される前にキャンセルされます。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CanceledSendMessageBytes | ネットワーク内のすべてのローカル エンドポイントからすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、キャンセルされたメッセージ内のデータのバイト数の合計。 メッセージは、アプリケーションが一致するフィルター式で PartyLocalEndpoint::CancelMessages() を呼び出すことによって、送信される前にキャンセルされます。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。そのようなメッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
要件
ヘッダー: Party.h関連項目
Party メンバーPartyEndpointStatistic
PartySendMessageOptions
PartyNetwork::GetNetworkStatistics
PartyLocalEndpoint::SendMessage
PartyLocalEndpoint::GetEndpointStatistics
