PartyEndpointStatistic

[アーティクル]
07/11/2023

エンドポイントで取得可能な統計情報の種類。

構文

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() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。
CurrentlyQueuedSendMessageBytes	現在、PartyLocalEndpoint::SendMessage() によってキューに入っているものの、ローカルエンドポイントから指定されたターゲットエンドポイントにまだ送信されていないメッセージにあるデータのバイト数。効率化のため、透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージバイトは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。
CurrentlyActiveSendMessages	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中のものや、まだ処理すべきローカル状態の変更が残っているものの数。メッセージは、その最初のバイトが送信中のパケットに配置された時点で、「アクティブ」とみなされます。送信が完了し、それに対するローカルの PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に戻されるまで、アクティブな状態が続きます。効率化のため、透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() ごとに単一のメッセージが追跡されます。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。
CurrentlyActiveSendMessageBytes	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、現在送信中のものや、まだ処理すべきローカル状態の変更が残っているもののデータのバイト数。メッセージは、その最初のバイトが送信中のパケットに配置された時点で、「アクティブ」とみなされます。送信が完了し、それに対するローカルの PartyDataBuffersReturnedStateChange (該当する場合) が PartyManager::FinishProcessingStateChanges() に戻されるまで、アクティブな状態が続きます。効率化のため、透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() ごとに単一のメッセージが追跡されます。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージバイトは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。
TimedOutSendMessages	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信キューのタイムアウトを超えたために送信されずに破棄されてしまったメッセージの合計数。メッセージの送信キューのタイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出す場合に PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。効率化のため、透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。 PartyLocalEndpoint::GetEndpointStatistics() にゼロエントリの配列を付与することで、すべてのターゲットエンドポイントへのこの統計を問い合わせを行う場合、現在存在するエンドポイントのみが含まれることに注意してください。メッセージをタイムアウトさせたエンドポイントがクエリ間で破壊された場合、このカウントは「後戻り」と認識される可能性があります。
TimedOutSendMessageBytes	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、送信キューのタイムアウトを超えたために送信されずに破棄されてしまったメッセージにあるデータのバイト数。メッセージの送信キューのタイムアウトは、PartyLocalEndpoint::SendMessage() を呼び出す場合に PartySendMessageQueuingConfiguration::timeoutInMillseconds を使用して指定します。効率化のため、透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージバイトは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。 PartyLocalEndpoint::GetEndpointStatistics() にゼロエントリの配列を付与することで、すべてのターゲットエンドポイントへのこの統計を問い合わせを行う場合、現在存在するエンドポイントのみが含まれることに注意してください。メッセージをタイムアウトさせたエンドポイントがクエリ間で破壊された場合、このカウントは「後戻り」と認識される可能性があります。
CanceledSendMessages	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、これまでにキャンセルされたデータのバイト数。メッセージは、アプリケーションが PartyLocalEndpoint::CancelMessages() を一致するフィルター式を使用して呼び出すことで、送信前にキャンセルされます。効率化のため、PartyNetwork 透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。 PartyLocalEndpoint::GetEndpointStatistics() にゼロエントリの配列を付与することで、すべてのターゲットエンドポイントへのこの統計を問い合わせを行う場合、現在存在するエンドポイントのみが含まれることに注意してください。メッセージをキャンセルしたエンドポイントがクエリ間で破壊された場合、このカウントは「後戻り」と認識される可能性があります。
CanceledSendMessageBytes	ローカルエンドポイントから指定されたターゲットエンドポイントへの PartyLocalEndpoint::SendMessage() メッセージのうち、これまでにキャンセルされたデータのバイト数。メッセージは、アプリケーションが PartyLocalEndpoint::CancelMessages() を一致するフィルター式を使用して呼び出すことで、送信前にキャンセルされます。効率化のため、PartyNetwork 透過型クラウドリレーサーバーを介して複数のターゲットエンドポイントに一度に送信する場合、PartyLocalEndpoint::SendMessage() では単一のメッセージのみがキューに入ります。この統計の問い合わせを行う場合に、PartyLocalEndpoint::GetEndpointStatistics() にそれらのエンドポイントが 2 つ以上指定された場合、メッセージバイトは対象のエンドポイントごとに乗算されるのではなく、1 回だけカウントされます。 PartyLocalEndpoint::GetEndpointStatistics() にゼロエントリの配列を付与することで、すべてのターゲットエンドポイントへのこの統計を問い合わせを行う場合、現在存在するエンドポイントのみが含まれることに注意してください。メッセージをキャンセルしたエンドポイントがクエリ間で破壊された場合、このカウントは「後戻り」と認識される可能性があります。
AverageDeviceRoundTripLatencyInMilliseconds	エンドポイントの所有するデバイスに対する現在の移動平均ラウンドトリップ待機時間 (「ping time」) をミリ秒単位で表したもの。この待機時間は、このローカルデバイスがメッセージを送信し、ターゲットのエンドポイントのデバイスからの応答を受信するまでに現在かかっている時間の移動平均を表しています。この統計は、一度に正確に 1 つのターゲットエンドポイントに対してのみクエリすることができます。 PartyLocalEndpoint::GetEndpointStatistics() メソッドは、複数のターゲットが指定された場合や、現在のすべてのエンドポイントのクエリを試みたもののゼロエントリの配列が指定された場合に失敗します。 PartyNetwork::GetNetworkStatistics() を使用して PartyNetworkStatistic::AverageRelayServerRoundTripLatencyInMilliseconds 統計情報を取得することで、ネットワークの透過型クラウドリレーサーバーに対するローカルデバイスの平均ラウンドトリップ待機時間を決定することもできます。

要件

ヘッダー: Party.h

次の方法で共有

PartyEndpointStatistic

構文

定数

要件

関連項目

フィードバック

その他のリソース