本文へスキップ

class LightshipNetcodeTransport

(Niantic.Lightship.SharedAR.Netcode.LightshipNetcodeTransport)

概要​

GameObjects互換レイヤー用のLightshipのNetcode。 RoomおよびINetworking apisを使用して実装。

	class LightshipNetcodeTransport：NetworkTransport {
	public：
	
		struct CachedEvent;
		struct NetcodeSessionStats;

		// プロパティ
	
		override ulong ServerClientId;

		// メソッド
	
		NetcodeSessionStats GetNetcodeSessionStats();
	
		override void Send(
			ulong clientId,
			ArraySegment<byte> data,
			NetworkDelivery delivery = NetworkDelivery.Reliable
		);
	
		override NetworkEvent PollEvent(
			out ulong clientId,
			out ArraySegment<byte> payload,
			out float receiveTime
		);
	
		void SetRoom(IRoom room);
		override bool StartClient();
		override bool StartServer()；
		override void DisconnectRemoteClient(ulong clientId);
		override void DisconnectLocalClient();
		override ulong GetCurrentRtt(ulong clientId);
		override void Shutdown();
		override void Initialize(NetworkManager manager);
		uint GetLastNetworkError();
	}；

詳細なドキュメント​

GameObjects互換レイヤー用のLightshipのNetcode。 RoomおよびINetworking apisを使用して実装。

プロパティ​

ServerClientId​

override ulong ServerClientId

サーバを表す定数netcode clientId この値がSendなどのメソッドで見つかった場合、サーバを意味するプレースホルダとして扱われる。

    パラメーター:

    networkManager - ネットコードセッションを管理する NetworkManager

メソッド​

GetNetcodeSessionStats​

NetcodeSessionStats GetNetcodeSessionStats()

アクティブなネットコードセッションの現在の統計情報をポーリングする。

Send​

override void Send(
		ulong clientId,
		ArraySegment<byte> data,
		NetworkDelivery delivery = NetworkDelivery.Reliable
	)

指定されたclientId、data、networkDeliveryにペイロードを送信する。

    パラメーター:

    clientId - 送信先のクライアントID。

    payload - 送信するデータ。

    networkDelivery - データを送信するデリバリータイプ（QoS）。

PollEvent​

override NetworkEvent PollEvent(
		out ulong clientId,
		out ArraySegment<byte> payload,
		out float receiveTime
	)

イベントが受信された正確な時刻を報告するための追加出力パラメータを持つ、受信イベントのポーリング。

    パラメーター:

    clientId - このイベントが対象とするクライアントID

    payload - 受信データのペイロード

    receiveTime - Time.realtimeSinceStartupによって報告された、イベントを受信した時刻。

    戻り値:

    イベントタイプを返す

SetRoom​

void SetRoom(IRoom room)

GameobjectsにNetcodeを使いたいLightship Roomを設定します。 StartClient "または "StartServer "を呼び出す前に設定します。

StartClient​

override bool StartClient()

クライアントとサーバーを接続する

    戻り値:

    成功または失敗を返す

StartServer​

override bool StartServer()

受信クライアントのリスニングを開始

    戻り値:

    成功または失敗を返す

DisconnectRemoteClient​

override void DisconnectRemoteClient(ulong clientId)

サーバからクライアントを切断する

    パラメーター:

    clientId - 接続を切断するクライアント Id

DisconnectLocalClient​

override void DisconnectLocalClient()

ローカルクライアントをサーバーから切断する

GetCurrentRtt​

override ulong GetCurrentRtt(ulong clientId)

特定のクライアントの往復所要時間を取得します。 このメソッドはLightshipには実装されていません。

    パラメーター:

    clientId - RTT を取得するクライアント ID。

    戻り値:

    常に 0 を返す

Shutdown​

override void Shutdown()

転送を停止する

Initialize​

override void Initialize(NetworkManager manager)

トランスポートを初期化します。 Netcodeによって自動的に呼び出されます。

    パラメーター:

    networkManager - ネットコードセッションを管理する NetworkManager

GetLastNetworkError​

uint GetLastNetworkError()

直近のネットワークエラーからエラーコードを取得します。 エラーがなければ0を返します。 エラーコードは Niantic.Lightship.SharedAR.Networking.NetworkEventErrorCode で const として定義されています。

    戻り値:

    エラーコード