PartyNetworkStatistic

  • [アーティクル]

ネットワークで取得可能な統計情報の種類。

構文

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 time」) をミリ秒単位で表したもの。

この待機時間は、このローカル デバイスがメッセージを送信し、透過型クラウド リレー サーバーからの応答を受信するまでに現在かかっている時間の移動平均を表しています。

PartyLocalEndpoint::GetEndpointStatistics() を使用して PartyEndpointStatistic::AverageDeviceRoundTripLatencyInMilliseconds 統計情報を取得することで、ネットワーク内の特定のローカル エンドポイントの他のエンドポイントへの平均ラウンドトリップ待機時間を決定することもできます。
SentProtocolPackets このネットワークの一部として、これまでにリモート デバイスに送信された内部プロトコル パケットの合計数。

この統計は、何らかのネットワーク上の理由でローカル デバイスが送信した内部プロトコル パケットの総数を表します。 これは、PartyLocalEndpoint::SendMessage() 呼び出し　の結果として生成されたパケットを含みますが、構成要素や環境要素に応じて、複数の小さなメッセージが合体してひとつのパケットになったり、大きなメッセージが複数のパケットに分割されたりするため、必ずしもそれらと 1 対 1 で対応するものではありません。 さらに、パケットは、明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしに、アプリケーションに代わってチャットその他の内部ライブラリ機能 (API 操作サポート メッセージ、プロトコルの確認や再試行など) を運搬するために使用される場合もあります。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作で生成されたパケットは含まれていません。
SentProtocolBytes このネットワークの一部として、これまでにリモート デバイスに送信された内部プロトコルの合計バイト数。

この統計は、何らかのネットワーク上の理由でローカル デバイスが送信した内部プロトコル パケットの合計バイト数を表します。 このサイズには、PartyLocalEndpoint::SendMessage() ペイロードだけでなく、それらの内部プロトコルのオーバーヘッドや、明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしに、アプリケーションに代わって必要とされるチャットその他の内部ライブラリ機能 (API 操作サポート メッセージ、プロトコルの確認や再試行など) も含まれます。

報告された値には、インターネット プロトコル (UDP、IP など) のパケット オーバーヘッドや、パーティ ライブラリの内部プロトコルが動作する低レベル メディアのオーバーヘッドは含まれていません。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作で生成されたパケットのサイズは含まれていません。
RetriedProtocolPackets このネットワークの一部として、これまでにリモート デバイスに再送信された内部プロトコル パケットの合計数。

この統計情報は、以前の試行の明らかな環境的損失に起因する、ローカル デバイスによる内部プロトコル パケットを再送信した合計数を表します。 Party ライブラリは、PartySendMessageOptions::GuaranteedDelivery を使用して送信されたアプリケーション メッセージ、または同様の配信要件を使用した内部ライブラリメッセージを含む損失パケットのみを再試行します。

この統計情報には、認証、管理トランザクション、音声変換、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している、HTTP Web クライアント操作のために生成されたパケットの再試行は含まれていません。
RetriedProtocolBytes このネットワークの一部として、これまでにリモート デバイスに再送信された内部プロトコルの合計バイト数。

この統計情報は、以前の試行の明らかな環境的損失に起因する、ローカル デバイスによる内部プロトコル パケットを再送信した合計バイト数を表します。 このサイズには、PartySendMessageOptions::GuaranteedDelivery を使用して送信されたアプリケーション メッセージ、または同様の配信要件を使用した内部ライブラリメッセージのペイロードが含まれます。

報告された値には、インターネット プロトコル (UDP、IP など) の再試行したパケット オーバーヘッドや、パーティ ライブラリの内部プロトコルが動作する低レベル メディアのオーバーヘッドは含まれていません。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作で生成された再試行したパケットのサイズは含まれていません。
DroppedProtocolPackets このネットワーク内のリモート機器への内部プロトコル パケットのうち、ドロップされたと考えられる合計数。



この統計情報は、思考されたものの環境的損失を引き起こした、ローカル デバイスによる内部プロトコル パケットを送信した合計数を表します。 これらは再試行されている場合もあれば、されていない場合もあります (RetriedProtocolPackets 参照)。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作で生成されたドロップしたパケットは含まれていません。
ReceivedProtocolPackets このネットワークの一部として、これまでにリモート デバイスで受信された内部プロトコル パケットの合計数。

この統計は、何らかのネットワーク上の理由でローカル デバイスが受信した内部プロトコル パケットの合計数を表しており、PartyEndpointMessageReceivedStateChange と 1 対 1 で対応していません。 構成要素や環境要素に応じて、複数の小さなメッセージをまとめて 1 つのパケットにしたり、大きなメッセージを複数のパケットに分割したりします。 さらに、パケットは、明示的な PartyLocalEndpoint::SendMessage() 呼び出しなしに、アプリケーションに代わってチャットその他の内部ライブラリ機能 (API 操作サポート メッセージ、プロトコルの確認や再試行など) を運搬するために使用される場合もあります。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作の一部として受信したパケットは含まれていません。
ReceivedProtocolBytes このネットワークの一部として、これまでにリモート デバイスで受信された内部プロトコルの合計バイト数。

この統計は、何らかのネットワーク上の理由でローカル デバイスで受信された内部プロトコル パケットの合計バイト数を表します。 このサイズには、PartyEndpointMessageReceivedStateChange::SendMessage() ペイロードだけでなく、それらの内部プロトコルのオーバーヘッドや、必要とされるチャットその他の内部ライブラリ機能 (API 操作サポート メッセージ、プロトコルの確認や再試行など) も含まれます。

報告された値には、インターネット プロトコル (UDP、IP など) のパケット オーバーヘッドや、パーティ ライブラリの内部プロトコルが動作する低レベル メディアのオーバーヘッドは含まれていません。

この統計情報には、認証、管理トランザクション、音声変換トランスクリプション、テキスト音声変換の合成の一部として Party ライブラリが内部的に使用している HTTP Web クライアント操作の一部として受信したパケットのサイズは含まれていません。
CurrentlyQueuedSendMessages 現在、PartyLocalEndpoint::SendMessage() によってキューに入っているものの、すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントにまだ送信されていないメッセージの数。



効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
CurrentlyQueuedSendMessageBytes 現在、PartyLocalEndpoint::SendMessage() によってキューに入っているものの、すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントにまだ送信されていないメッセージ内のデータのバイト数。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージのバイトは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
CurrentlyActiveSendMessages すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中のものや、まだ処理すべきローカル状態の変更が残っているものの数。

メッセージは、その最初のバイトが送信中のパケットに配置された時点で、「アクティブ」とみなされます。 送信が完了し、それに対するローカルの PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に戻されるまで、アクティブな状態が続きます。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
CurrentlyActiveSendMessageBytes すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中のものや、まだ処理すべきローカル状態の変更が残っているデータのバイト数。

メッセージは、その最初のバイトが送信中のパケットに配置された時点で、「アクティブ」とみなされます。 送信が完了し、それに対するローカルの PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に戻されるまで、アクティブな状態が続きます。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージのバイトは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
TimedOutSendMessages すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信キューのタイムアウトを超えたために送信されずに破棄されてしまったメッセージの合計数。

メッセージの送信キューのタイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出す場合に PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
TimedOutSendMessageBytes すべてのローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信キューのタイムアウトを超えたために送信されずに破棄されてしまったメッセージのデータの合計バイト数。

メッセージの送信キューのタイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出す場合に PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージのバイトは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
CanceledSendMessages ローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、これまでにキャンセルされたデータのバイト数。

メッセージは、アプリケーションが PartyLocalEndpoint::CancelMessages() を一致するフィルター式を使用して呼び出すことで、送信前にキャンセルされます。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。
CanceledSendMessageBytes ローカル エンドポイントからネットワーク内のすべてのリモート エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、これまでにキャンセルされたデータの合計バイト数。

メッセージは、アプリケーションが PartyLocalEndpoint::CancelMessages() を一致するフィルター式を使用して呼び出すことで、送信前にキャンセルされます。

効率化のため、透過型クラウド リレー サーバーを介して複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。 このようなメッセージのバイトは、対象エンドポイントごとにカウントされるのではなく、1 回だけカウントされます。

要件

ヘッダー: Party.h

関連項目

パーティーのメンバー
PartyEndpointStatistic
PartySendMessageOptions
PartyNetwork::GetNetworkStatistics
PartyLocalEndpoint::SendMessage
PartyLocalEndpoint::GetEndpointStatistics