第4回:FishNetによる切断・再接続と接続状態の管理
はじめに
前回は、FishNetのNetworkObjectやNetworkTransform、RPC、SyncVarなどを使用して、ゲームオブジェクトの生成や同期の仕組みを紹介しました。
今回は、FishNetによる切断・再接続処理と、接続状態の管理方法について解説します。
マルチプレイでは、HostとClientが接続できることだけでなく、プレイヤーが退出した場合やHostが停止した場合にも適切に対応する必要があります。
また、一度切断した後に再接続するには、前の接続が終了したことを確認してから、接続処理を開始する必要があります。
今回は、検証用プロジェクトで実装したP2PConnectionTestを例に、FishNetの接続管理に関する機能とその使い方を紹介します。
本記事は全4回のシリーズの最終回です。
今回紹介する内容
-
ClientManagerとServerManagerの役割 -
StopConnectionによる切断処理 - 接続状態を監視するイベント
-
OnRemoteConnectionStateによる参加者の接続状態の取得 - 切断後の手動再接続
- 接続管理で注意すること
使用した検証環境
今回も第2回で構築したFishNet・FishyEOS・EOSの通信環境を使用しています。
MPPMでは、以下の構成で検証しました。
| 実行環境 | 役割 |
|---|---|
| Main Editor | Host |
| Virtual Player | Client |
この記事では、実際に検証用プロジェクトへ実装したコードを中心に紹介します。
コード例では、イベントと処理メソッドを区別しやすくするため、イベントハンドラー名をHandle〜に統一しています。
また、今回の再接続は、切断後に手動で接続をやり直す方式です。自動再接続や、切断前のゲーム状態を復元する機能は実装していません。
1. FishNetの接続管理
FishNetでは、ClientとServerの接続をそれぞれ管理するためのManagerが用意されています。
| クラス | 役割 |
|---|---|
| ClientManager | Client自身の接続を管理する |
| ServerManager | Serverの起動・停止や接続Clientを管理する |
例えば、Host-Client方式ではHostがServerとClientの両方として動作します。
Host
├── Server
└── Client
Player 2
└── Client
そのため、HostのServerを停止する処理と、Client自身が接続を終了する処理は別です。
FishNetでは、それぞれ次のように呼び出します。
// Client自身の接続を停止する
InstanceFinder.ClientManager.StopConnection();
// Serverを停止する
InstanceFinder.ServerManager.StopConnection(true);
InstanceFinderは、FishNetのManagerにアクセスするためのクラスです。
この2つの処理がどのように異なるのか、順番に説明します。
2. Clientの切断処理
2-1. StopConnectionとは
Clientの接続を終了するには、ClientManager.StopConnectionを使用します。
例えば、プレイヤーがマルチプレイから退出してタイトル画面へ戻る場合などに利用できます。
今回のP2PConnectionTestでは、次のように実装しました。
/// <summary>
/// Client自身の接続を停止する
/// </summary>
public void StopClient()
{
// Clientが起動していなければ停止処理を行わない
if (!InstanceFinder.ClientManager.Started)
{
Debug.LogWarning("クライアントは起動していません。");
return;
}
Debug.Log("Clientの停止を要求しました。");
// 自分自身のClient接続を停止する
InstanceFinder.ClientManager.StopConnection();
}
ここで使用しているClientManager.Startedは、Clientの接続が開始済みか確認するためのプロパティです。
今回の実装では、このプロパティを使用して接続状態を確認し、Clientが起動していない場合は停止処理を行わないようにしています。
ただし、未接続状態でStopConnection()を呼び出しても、今回の環境では例外は発生せず、戻り値としてfalseが返されました。
そのため、このチェックは例外を防ぐために必須というわけではなく、不要な停止要求を避けるためのものです。
StopConnection()の戻り値はbool型で、停止要求を開始できた場合はtrue、開始できなかった場合はfalseを返します。
なお、戻り値がtrueでも、切断処理がすべて完了したことを意味するわけではありません。
次の節では、Clientが切断した際に接続状態がどのように変化するのかを説明します。
2-2. Clientが切断した場合
今回の構成でPlayer 2が切断した場合、接続状態は次のようになります。
切断前
Host
├── Server
└── Client
│
│ P2P接続
│
Player 2
└── Client
切断後
Host
├── Server:起動中
└── Client:接続中
Player 2
└── Client:停止
Player 2が切断しても、HostのServerが自動的に停止するわけではありません。
そのため、ほかのプレイヤーが接続している場合でも、特定のClientだけを退出させることができます。
ただし、実際のゲームでは、退出したプレイヤーの情報やゲームオブジェクトをどう扱うかについても考える必要があります。
3. Serverの停止処理
次に、Server側の接続を停止する方法を紹介します。
3-1. ServerManager.StopConnection
今回の検証では、次のように実装しています。
/// <summary>
/// Serverを停止する
/// </summary>
public void StopServer()
{
// Serverが起動していなければ停止処理を行わない
if (!InstanceFinder.ServerManager.Started)
{
Debug.LogWarning("サーバーは起動していません。");
return;
}
Debug.Log("Serverの停止を要求しました。");
// Serverを停止する
InstanceFinder.ServerManager.StopConnection(true);
}
ServerManager.Startedは、Serverが起動しているか確認するプロパティです。
実際にServerを停止するのは次の処理です。
InstanceFinder.ServerManager.StopConnection(true);
ここで指定しているtrueは、接続中のClientの切断処理を伴ってServerを停止するための指定です。
3-2. Hostが停止した場合
Host-Client方式では、HostがServerの役割を担当しています。
そのため、HostのServerが停止すると、ほかのClientも接続を維持できなくなります。
Host
├── Server:停止
└── Client
×
× 接続終了
×
Player 2
└── Client:接続終了
Player 2が自分から切断した場合とは異なり、Serverの停止は接続しているClient全体に影響します。
また、Host自身もClientとして接続しているため、セッション全体を終了する場合はHost自身のClient側の停止やゲーム内の状態管理も考慮する必要があります。
4. 接続状態を監視する
ここまで紹介したStopConnectionは、接続の停止を要求するメソッドです。
しかし、メソッドを呼び出したタイミングと、実際に接続が終了したタイミングは必ずしも同じではありません。
また、プレイヤーが切断ボタンを押さなくても、Hostの停止などによって接続が終了する場合があります。
こうした状態の変化を取得するために、FishNetでは接続状態変更イベントが用意されています。
4-1. 接続状態変更イベント
今回使用している主なイベントは以下のとおりです。
| イベント | 役割 |
|---|---|
| OnClientConnectionState | Client自身の接続状態の変更を通知する |
| OnServerConnectionState | Server自身の接続状態の変更を通知する |
| OnAuthenticated | FishNetによるClient認証が完了した際に通知する |
今回のP2PConnectionTestでは、以下のようにイベントを登録しています。
private void OnEnable()
{
// Client自身の接続状態を監視する
InstanceFinder.ClientManager.OnClientConnectionState +=
HandleClientConnectionState;
// Server自身の起動・停止状態を監視する
InstanceFinder.ServerManager.OnServerConnectionState +=
HandleServerConnectionState;
// FishNet側のClient認証完了を監視する
InstanceFinder.ClientManager.OnAuthenticated +=
HandleAuthenticated;
}
このように、FishNetが提供するOn〜イベントに、自作したHandle〜メソッドを登録します。
これにより、接続開始や切断などによって状態が変化した際に、対応するメソッドが呼び出されます。
4-2. Clientの接続状態を取得する
Client自身の接続状態を取得するには、OnClientConnectionStateを使用します。
今回の実装では、次のようにしています。
private void HandleClientConnectionState(ClientConnectionStateArgs args)
{
// 現在のClient接続状態を出力する
Debug.Log($"Client接続状態: {args.ConnectionState}");
// 接続が終了した場合だけ処理する
if (args.ConnectionState != LocalConnectionState.Stopped)
{
return;
}
Debug.LogWarning("サーバーとの接続が終了しました。");
}
ClientConnectionStateArgsは、Clientの接続状態に関する情報を保持する型です。
args.ConnectionStateから現在の状態を確認できます。
LocalConnectionStateには、以下の状態があります。
| 状態 | 意味 |
|---|---|
| Stopped | 停止している |
| Starting | 接続開始処理中 |
| Started | 接続が開始されている |
| Stopping | 接続停止処理中 |
今回の実装では、Stoppedになった場合に切断ログを出力します。
このイベントを利用することで、Client自身が切断した場合だけでなく、Hostとの接続が終了した場合も検知できます。
ただし、Stoppedになったという情報だけでは、切断の原因までは分かりません。
今回のコードでは、自分から切断した場合とHost側で接続が終了した場合を区別していません。
4-3. Serverの接続状態を取得する
Server自身の状態を取得するには、OnServerConnectionStateを使用します。
private void HandleServerConnectionState(ServerConnectionStateArgs args)
{
// Server自身の起動・停止状態を確認する
Debug.Log($"Server接続状態: {args.ConnectionState}");
}
ServerConnectionStateArgsは、Serverの接続状態に関する情報を保持する型です。
今回の実装では、Serverが起動・停止した際の状態をConsoleへ出力しています。
なお、これはServer自身の状態を監視するイベントです。
Serverに接続している個別のClientの状態を確認する場合は、別のイベントを使用します。
4-4. 認証完了を取得する
FishNet側のClient認証完了はOnAuthenticatedで取得できます。
今回の実装では、以下のようにログを出力しています。
private void HandleAuthenticated()
{
// FishNet側のClient認証が完了したことを確認する
Debug.Log("FishNetへの接続・認証が完了しました。");
}
接続開始を要求したことと、認証が完了したことは別です。
そのため、認証完了後に処理を開始したい場合は、このイベントを利用できます。
5. Server側でClientの接続・切断を監視する
ここまで紹介したOnClientConnectionStateは、Client自身の接続状態を監視するためのイベントです。
一方、Server側で「どのClientが接続したのか」「どのClientが切断したのか」を取得したい場合は、OnRemoteConnectionStateを使用します。
5-1. OnRemoteConnectionStateとは
OnRemoteConnectionStateは、Server側で接続しているClientの状態変更を取得するためのイベントです。
例えば、参加者一覧の更新や、プレイヤーの退出処理などに利用できます。
以下は使用方法を説明するためのサンプルコードです。
using FishNet;
using FishNet.Connection;
using FishNet.Transporting;
using UnityEngine;
public class ServerConnectionObserver : MonoBehaviour
{
private void OnEnable()
{
// Serverに接続しているClientの状態変更を監視する
InstanceFinder.ServerManager.OnRemoteConnectionState +=
HandleRemoteConnectionState;
}
private void OnDisable()
{
if (InstanceFinder.ServerManager != null)
{
// イベントの登録を解除する
InstanceFinder.ServerManager.OnRemoteConnectionState -=
HandleRemoteConnectionState;
}
}
private void HandleRemoteConnectionState(
NetworkConnection connection,
RemoteConnectionStateArgs args)
{
if (args.ConnectionState == RemoteConnectionState.Started)
{
// 接続したClientのIDを表示する
Debug.Log($"Client接続: {connection.ClientId}");
}
else if (args.ConnectionState == RemoteConnectionState.Stopped)
{
// 切断したClientのIDを表示する
Debug.Log($"Client切断: {connection.ClientId}");
}
}
}
このコードでは、Clientの接続状態が変更された際にHandleRemoteConnectionStateが呼び出されます。
NetworkConnectionは、接続しているClientの情報を保持する型です。
ClientIdは、FishNetがClientを識別するためのIDです。
RemoteConnectionStateArgsから、接続先Clientの状態を取得できます。
例えば、Clientが切断されたときに、そのClientIdに対応するプレイヤーデータを削除するといった処理に利用できます。
このコードはOnRemoteConnectionStateの使い方を説明するためのサンプルです。
今回のP2PConnectionTestでは、ClientとServer自身の接続状態を中心に監視しています。
5-2. 接続状態イベントの使い分け
それぞれのイベントの違いを整理すると、以下のようになります。
| イベント | 監視対象 |
|---|---|
| OnClientConnectionState | 自分自身のClient |
| OnServerConnectionState | 自分自身のServer |
| OnRemoteConnectionState | Serverに接続しているClient |
例えば、Hostが停止したことをClient側で検知したい場合は、OnClientConnectionStateを使用できます。
一方、Player 2が退出したことをHostのServer側で検知したい場合は、OnRemoteConnectionStateを使用します。
6. 切断後の再接続処理
次に、一度切断したClientが再びHostへ接続する方法を紹介します。
6-1. 再接続の基本
今回の検証では、接続が終了した後に、再度StartClientを実行する方式を使用しています。
ClientがHostへ接続
↓
接続が確立
↓
StopClientで切断
↓
接続が終了
↓
StartClientを再実行
↓
再接続を開始
ここで重要なのは、前の接続が終了したことを確認してから、新しい接続処理を開始するという点です。
例えば、切断処理中に新しい接続を開始すると、Transportの状態によっては正常に接続できない可能性があります。
そのため、接続状態を確認しながら処理を行う必要があります。
6-2. StartClientの実装
今回のP2PConnectionTestでは、次のように接続処理を実装しています。
/// <summary>
/// HostのPUIDを指定してClient接続を開始する
/// </summary>
public void StartClient()
{
// 接続先HostのPUIDが未設定なら中断する
if (string.IsNullOrWhiteSpace(_hostProductUserId))
{
Debug.LogError("ホストのPUIDが設定されていません。");
return;
}
// Clientが既に起動している場合は重複して接続しない
if (InstanceFinder.ClientManager.Started)
{
Debug.LogWarning("クライアントは既に起動しています。");
return;
}
// 現在使用しているTransportがFishyEOSか確認する
if (InstanceFinder.NetworkManager.TransportManager.Transport
is not FishyEOS transport)
{
Debug.LogError("TransportがFishyEOSではありません。");
return;
}
// 接続先となるHostのPUIDを設定する
transport.RemoteProductUserId = _hostProductUserId;
Debug.Log($"ホストへの接続を開始します: {_hostProductUserId}");
// Clientの接続を開始する
InstanceFinder.ClientManager.StartConnection();
}
このコードでは、接続開始前に次の内容を確認しています。
- 接続先HostのPUIDが設定されているか
- Clientがすでに起動していないか
- TransportがFishyEOSであるか
問題がなければ、HostのPUIDを設定してからStartConnectionを呼び出します。
// 接続先HostのPUIDを設定
transport.RemoteProductUserId = _hostProductUserId;
// Hostへの接続を開始
InstanceFinder.ClientManager.StartConnection();
RemoteProductUserIdは、FishyEOSで接続先となるユーザーのPUIDを指定するプロパティです。
今回の実装では、HostのPUIDを手動で設定しています。
6-3. 再接続時に注意すること
今回のStartClientでは、ClientManager.Startedによって、すでに起動しているClientからの重複接続を防いでいます。
ただし、この判定だけでは接続開始中や停止処理中の状態まで完全に管理できるわけではありません。
例えば、次のような状態が考えられます。
| 状態 | 処理 |
|---|---|
| Stopped | 新しい接続を開始できる状態 |
| Starting | 接続開始中のため、重複して開始しない |
| Started | 接続中のため、重複して開始しない |
| Stopping | 切断完了を待つ |
より厳密に再接続を管理する場合は、OnClientConnectionStateなどで接続状態を監視し、停止が完了した後に次の接続を開始する必要があります。
また、通信の再接続に成功しても、切断前のプレイヤーやゲーム進行が自動的に復元されるわけではありません。
今回の検証コードでは、通信の再接続までを扱い、ゲーム状態の復元処理は実装していません。
7. 検証用のキー操作
今回のP2PConnectionTestでは、接続と切断の処理を簡単に呼び出せるよう、Input Systemでキー操作を用意しています。
private void Update()
{
Keyboard keyboard = Keyboard.current;
if (keyboard == null)
{
return;
}
// F8キーでClient接続を開始する
if (keyboard.f8Key.wasPressedThisFrame)
{
StartClient();
}
// F9キーでClient接続を停止する
if (keyboard.f9Key.wasPressedThisFrame)
{
StopClient();
}
// F10キーでServerを停止する
if (keyboard.f10Key.wasPressedThisFrame)
{
StopServer();
}
}
各キーの役割は以下のとおりです。
| キー | 処理 |
|---|---|
| F8 | Clientの接続開始 |
| F9 | Clientの接続停止 |
| F10 | Serverの停止 |
今回は、この操作によってClientの切断や再接続、Hostの停止を呼び出せるようにしました。
なお、このキー操作は検証用です。実際のゲームでは、UIのボタンなどから接続処理を呼び出す構成にできます。
8. 接続イベントの登録と解除
接続状態の監視では、イベントを登録するだけでなく、不要になった際に解除することも重要です。
例えば、オブジェクトが無効になった後もイベントが登録されたままだと、想定していないタイミングでメソッドが呼ばれる場合があります。
今回の実装では、OnEnableでイベントを登録し、OnDisableで解除しています。
private void OnEnable()
{
// Clientの接続状態変更イベントを登録
InstanceFinder.ClientManager.OnClientConnectionState +=
HandleClientConnectionState;
// Serverの接続状態変更イベントを登録
InstanceFinder.ServerManager.OnServerConnectionState +=
HandleServerConnectionState;
// FishNet側の認証完了イベントを登録
InstanceFinder.ClientManager.OnAuthenticated +=
HandleAuthenticated;
}
private void OnDisable()
{
if (InstanceFinder.ClientManager != null)
{
// Client関連のイベント登録を解除
InstanceFinder.ClientManager.OnClientConnectionState -=
HandleClientConnectionState;
InstanceFinder.ClientManager.OnAuthenticated -=
HandleAuthenticated;
}
if (InstanceFinder.ServerManager != null)
{
// Server関連のイベント登録を解除
InstanceFinder.ServerManager.OnServerConnectionState -=
HandleServerConnectionState;
}
}
+=でイベントを登録し、-=で解除しています。
接続・切断を繰り返す環境では、イベントが重複して登録されたり、不要な参照が残ったりしないように注意する必要があります。
9. 実装時に注意すること
9-1. 切断要求と切断完了は異なる
StopConnectionを呼び出した直後に、すべての切断処理が完了しているとは限りません。
そのため、切断後に再接続やシーン遷移などを行う場合は、状態変更イベントを使用して停止完了を確認することが重要です。
今回の実装では、OnClientConnectionStateやOnServerConnectionStateで接続状態を監視しています。
9-2. 切断理由は別途管理する必要がある
今回のP2PConnectionTestでは、Client自身が切断した場合とHost側で接続が終了した場合を区別していません。
例えば、タイトル画面で異なるメッセージを表示したい場合は、切断を要求した理由などを管理する必要があります。
| 状況 | 表示例 |
|---|---|
| 自分から退出 | タイトル画面に戻りました |
| Hostが停止 | Hostとの接続が終了しました |
| 通信切断 | 通信が切断されました |
このような機能は、実際のゲームへ組み込む際に追加することになります。
9-3. Domain Reloadの設定
第2回でも紹介しましたが、MPPMで接続テストを繰り返した際、2回目以降のPlayで例外が発生する問題がありました。
今回の環境では、Play Modeへの移行を高速化するためにDomain Reloadを無効にしていたことが原因と考えられ、Reload Domain and Sceneに変更することで解消しました。
また、以前発生していたVirtual Player側のローカル同期の問題も解消しました。
この問題の詳細は第2回で紹介しているため、ここでは省略します。
同じ例外が必ずしもDomain Reloadの設定によって発生するとは限りません。
接続・切断を繰り返した際に問題が発生した場合は、Play Modeの設定やイベントの登録・解除、接続状態の管理などを確認してください。
10. まとめ
今回は、FishNetによる切断・再接続処理と、接続状態の管理方法を紹介しました。
主な機能を整理すると、以下のようになります。
| 機能 | 役割 |
|---|---|
| ClientManager.StopConnection | Clientの接続を停止する |
| ServerManager.StopConnection | Serverを停止する |
| OnClientConnectionState | Client自身の接続状態を監視する |
| OnServerConnectionState | Server自身の接続状態を監視する |
| OnRemoteConnectionState | Server側で個別のClientの状態を監視する |
| OnAuthenticated | FishNetの認証完了を通知する |
| ClientManager.StartConnection | Clientの接続を開始する |
今回の検証では、ClientとServerの接続を手動で開始・停止し、接続状態の変化をイベントで確認する方法を紹介しました。
特に重要なのは、接続・切断を要求したことと、その処理が完了したことを区別するという点です。
実際のゲームでは、切断理由の管理や再接続時のゲーム状態の復元なども必要になりますが、まずはFishNetの接続状態を正しく扱うことが基本になります。
全4回を振り返って
今回の記事で、FishNet・FishyEOS・EOSを使用したP2Pマルチプレイ環境構築のシリーズは終了です。
| 回 | 内容 |
|---|---|
| 第1回 | FishNet・FishyEOS・EOSの導入と初期設定 |
| 第2回 | EOS認証とP2P接続の実装 |
| 第3回 | NetworkObject・RPC・SyncVarなどの同期処理 |
| 第4回 | 切断・再接続と接続状態の管理 |
今回のシリーズでは、将来的にSteamユーザー同士で通信することを目標に、まずDevice ID認証とDATを使用して通信基盤を検証しました。
Steam認証やマッチング機能までは実装していませんが、EOS Connectによるユーザー認証とFishyEOSを使用したP2P接続、FishNetによる基本的なネットワーク同期の仕組みを確認できました。
今後は、Steam認証への対応や実際のゲームへの組み込みを進めていきたいと考えています。