構文
enum class PartyEndpointStatistic
{
CurrentlyQueuedSendMessages = 0,
CurrentlyQueuedSendMessageBytes = 1,
CurrentlyActiveSendMessages = 2,
CurrentlyActiveSendMessageBytes = 3,
TimedOutSendMessages = 4,
TimedOutSendMessageBytes = 5,
CanceledSendMessages = 6,
CanceledSendMessageBytes = 7,
AverageDeviceRoundTripLatencyInMilliseconds = 8,
}
定数
| 定数 | 説明 |
|---|---|
| CurrentlyQueuedSendMessages | PartyLocalEndpoint::SendMessage() によって現在キューに入っているが、ローカル エンドポイントから指定されたターゲット エンドポイントにまだ送信されていないメッセージの数。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyQueuedSendMessageBytes | PartyLocalEndpoint::SendMessage() によって現在キューに入っているが、ローカル エンドポイントから指定されたターゲット エンドポイントにまだ送信されていないメッセージ内のデータのバイト数。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyActiveSendMessages | ローカル エンドポイントから指定されたターゲット エンドポイントへ現在送信中、またはまだ処理すべきローカル状態変更が残っている PartyLocalEndpoint::SendMessage() メッセージの数。 メッセージは、その最初のバイトが送信中のパケットに配置された時点で “アクティブ” とみなされます。送信が完了し、それに対応するローカル PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に返されるまでアクティブのままです。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() あたり追跡されるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| CurrentlyActiveSendMessageBytes | ローカル エンドポイントから指定されたターゲット エンドポイントへ現在送信中、またはまだ処理すべきローカル状態変更が残っている PartyLocalEndpoint::SendMessage() メッセージ内のデータのバイト数。 メッセージは、その最初のバイトが送信中のパケットに配置された時点で “アクティブ” とみなされます。送信が完了し、それに対応するローカル PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に返されるまでアクティブのままです。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() あたり追跡されるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 |
| TimedOutSendMessages | ローカル エンドポイントから指定されたターゲット エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信されずに送信キュー タイムアウトを超えたために破棄されたメッセージの合計数。 メッセージの送信キュー タイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出すときに PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 ゼロ エントリの配列を PartyLocalEndpoint::GetEndpointStatistics() に提供することで、すべてのターゲット エンドポイントに対してこの統計を照会する場合、現在存在するエンドポイントのみが含まれることに注意してください。タイムアウトしたメッセージを持っていたエンドポイントが照会と照会の間に破棄されると、このカウントは “逆行” しているように見える場合があります。 |
| TimedOutSendMessageBytes | ローカル エンドポイントから指定されたターゲット エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信されずに送信キュー タイムアウトを超えたために破棄されたメッセージ内のデータのバイト数の合計。 メッセージの送信キュー タイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出すときに PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。 効率のため、透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 ゼロ エントリの配列を PartyLocalEndpoint::GetEndpointStatistics() に提供することで、すべてのターゲット エンドポイントに対してこの統計を照会する場合、現在存在するエンドポイントのみが含まれることに注意してください。タイムアウトしたメッセージを持っていたエンドポイントが照会と照会の間に破棄されると、このカウントは “逆行” しているように見える場合があります。 |
| CanceledSendMessages | ローカル エンドポイントから指定されたターゲット エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、キャンセルされたメッセージの合計数。 メッセージは、アプリケーションが一致するフィルター式で PartyLocalEndpoint::CancelMessages() を呼び出すことによって、送信される前にキャンセルされます。 効率のため、PartyNetwork の透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージはターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 ゼロ エントリの配列を PartyLocalEndpoint::GetEndpointStatistics() に提供することで、すべてのターゲット エンドポイントに対してこの統計を照会する場合、現在存在するエンドポイントのみが含まれることに注意してください。キャンセルされたメッセージを持っていたエンドポイントが照会と照会の間に破棄されると、このカウントは “逆行” しているように見える場合があります。 |
| CanceledSendMessageBytes | ローカル エンドポイントから指定されたターゲット エンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、キャンセルされたメッセージ内のデータのバイト数の合計。 メッセージは、アプリケーションが一致するフィルター式で PartyLocalEndpoint::CancelMessages() を呼び出すことによって、送信される前にキャンセルされます。 効率のため、PartyNetwork の透過的クラウド リレー サーバー経由で複数のターゲット エンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() によってキューに入れられるメッセージは 1 つのみです。この統計を照会するときに PartyLocalEndpoint::GetEndpointStatistics() にこれらのエンドポイントのうち 2 つ以上が指定された場合、メッセージのバイト数はターゲット エンドポイントごとに乗算されるのではなく、1 回のみカウントされます。 ゼロ エントリの配列を PartyLocalEndpoint::GetEndpointStatistics() に提供することで、すべてのターゲット エンドポイントに対してこの統計を照会する場合、現在存在するエンドポイントのみが含まれることに注意してください。キャンセルされたメッセージを持っていたエンドポイントが照会と照会の間に破棄されると、このカウントは “逆行” しているように見える場合があります。 |
| AverageDeviceRoundTripLatencyInMilliseconds | エンドポイントの所有デバイスまでの現在のミリ秒単位の往復レイテンシー (“ping 時間”) の移動平均。 このレイテンシーは、このローカル デバイスがメッセージを送信し、ターゲット エンドポイントのデバイスから応答を受信するのに現在かかる時間の移動平均を表します。 この統計は、一度に厳密に 1 つのターゲット エンドポイントに対してのみ照会できます。PartyLocalEndpoint::GetEndpointStatistics() メソッドは、複数のターゲットが提供された場合、またはすべての現在のエンドポイントを照会しようとしてゼロ エントリの配列が提供された場合に失敗します。 PartyNetwork::GetNetworkStatistics() を使用して PartyNetworkStatistic::AverageRelayServerRoundTripLatencyInMilliseconds 統計を取得することで、ローカル デバイスからネットワークの透過的クラウド リレー サーバーへの平均往復レイテンシーも判別できます。 |
要件
ヘッダー: Party.h関連項目
Party メンバーPartyNetworkStatistic
PartySendMessageQueuingConfiguration
PartyLocalEndpoint::SendMessage
PartyLocalEndpoint::GetEndpointStatistics
PartyNetwork::GetNetworkStatistics