SteamPingThread - stingray.SteamPingThread オブジェクト リファレンス - Stingray Lua API リファレンス
説明
2 つのネットワーク カード間でメッセージがどの程度早く戻ってこれるかをレポートする、ping 時間を計測するために使用されます。
このオブジェクトはネットワーク カード間で Ping メッセージをやり取りすることのみを目的とした専用の高優先度スレッドを作成します。
Network.ping() によって報告される Ping 時間には、ネットワーク メッセージの合計ラウンドトリップ時間が含まれます。したがって、この時間には、フレーム内の特定のポイントでネットワーク メッセージが処理されてから、ネットワーク カードにメッセージが到達するまでの遅延が含まれます。Ping メッセージへの応答が返されるまでに半フレーム分の遅延が発生し、そのメッセージが受信されるまでにさらに半フレーム分の遅延が発生するため、合計で平均 1 フレーム分(30 fps の場合 33 ミリ秒)の遅延が発生します。この Ping 時間は、サーバがプレイヤーの操作にどのくらい速く反応できるかを示し、プレイヤーの体感にどのくらいの影響があるかを示すため、最も正確な Ping 時間と言えます。
SteamPingThread によって報告される Ping 時間は、実際の Ping 時間よりも小さい数値であり、プレイヤーの体感に直接結び付きます。
不要になった Ping スレッドを破壊してスレッドを解放するには、stingray.SteamPingThread.destroy() を呼び出す必要があります。ネットワークをシャットダウンするときは、必ずこれを行う必要があります。
注: このインタフェースは実験的なものであり、将来のバージョンで API が変更される可能性があります。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
add_peer ( self, peer_id ) Ping サーバで追跡するピアのリストに、指定されたピアを追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer_id : | string | Ping を送信するピアの ID を指定します。 |
| この関数は値を返しません。 |
追加されたピアに 2 秒間隔で Ping メッセージを送信し、応答時間を計測します。
追加されたピア側でも SteamPingThread が実行されている必要があり、そうでない場合は、ピアが Ping メッセージに応答しないため、Ping 時間を計測できません。ただし、リモート ピア側では、応答先のピアとして Ping メッセージの送信元を Ping スレッドに追加する必要はありません。
その他の関連リファレンス項目
| |
destroy ( self )指定された Ping スレッドを破壊して、使用されていたメモリをすべて解放し、スレッドを停止します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
この関数を呼び出した後は、指定された Ping スレッドに対して SteamPingThread インタフェースの他の関数を呼び出すことはできません。
| |
ping ( self, peer_id ) : number指定されたピアへの Ping 時間を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer_id : | string | Ping 時間を取得するピアの ID を指定します。 |
number |
Ping 時間(秒単位)を返し、リモート ピアへの接続が切断されたか、ピア側でSteamPingThread が実行されていないために Ping 時間を計測できない場合は 0 を返します。 |
| |
remove_peer ( self, peer_id )add_peer() で以前に追加されたピアを除去し、そのピアへの Ping 時間のトラッキングを停止します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer_id : | string | 除去するピアの ID を指定します。 |
| この関数は値を返しません。 |