サーバーAPI

サーバーの開始と停止リスナー

Socketio4j はサーバーのリスナーを登録することを許可します 開始 と 停止 イベント。 リスナーは次のもので安全に実行されます 例外隔離により、あるリスナーの失敗が他やサーバーのライフサイクルに影響を与えないようにします。

開始リスナー

開始リスナーを追加

ServerStartListener startListener = s -> {
    System.out.println(
        "サーバーが起動しました: " + s.getConfiguration().getPort()
    );
};

server.addStartListener(startListener);

開始リスナーを削除

server.removeStartListener(startListener);

停止リスナー

停止リスナーを追加

ServerStopListener stopListener = s -> {
    System.out.println("サーバーが停止しました");
};

server.addStopListener(stopListener);

停止リスナーを削除

server.removeStopListener(stopListener);

実行の保証

• 開始リスナーはサーバーが正常に起動した後に呼び出されます

• 停止リスナーはグレースフルシャットダウン中に呼び出されます

• 各リスナーは次の状態で実行されます 例外隔離

• リスナーによって投げられた例外は し 中断しません：

  • サーバーの起動またはシャットダウン

  • 他の登録済みリスナー

ベストプラクティス

• リスナーのロジックは軽量かつノンブロッキングに保つ

• リスナー内で長時間実行される処理やブロッキング操作を避ける

• リスナーはログ、メトリクス、調整のためにのみ使用する

ネームスペース

デフォルトネームスペース

ルートネームスペース（"/"）は自動的に作成されます。

ネームスペースを追加

SocketIONamespace chat = server.addNamespace("/chat");

ネームスペースを取得

SocketIONamespace chat = server.getNamespace("/chat");

ネームスペースを削除

server.removeNamespace("/chat");

すべてのネームスペースを取得

Collection<SocketIONamespace> namespaces = server.getAllNamespaces();

クライアント

接続中の全クライアントを取得（デフォルトネームスペース）

Collection<SocketIOClient> clients = server.getAllClients();

セッション ID でクライアントを取得

SocketIOClient client = server.getClient(uuid);

返します null 見つからない場合。

ブロードキャスト

すべてのクライアントへブロードキャスト（全ネームスペース）

server.getBroadcastOperations()
      .sendEvent("announcement", "Hello everyone");

ルームへブロードキャスト（全ネームスペース横断）

server.getRoomOperations("room1", "room2")
      .sendEvent("message", "Hello rooms");

イベントリスナー（デフォルトネームスペース）

イベントリスナー（型指定）

server.addEventListener("chat", Message.class, (client, data, ack) -> {
    System.out.println(data);
});

マルチタイプイベントリスナー

server.addMultiTypeEventListener(
    "event",
    (client, data, ack) -> {},
    String.class,
    ChatMessage.class
);

キャッチオールイベントリスナー

CatchAllEventListener anyListener = (client, event, args) -> {
    System.out.println("イベント: " + event);
};
// 追加
server.addOnAnyEventListener(anyListener);

// 削除
server.removeOnAnyEventListener(anyListener);

別名：

• onAny(...)

• offAny(...)

イベントインターセプター

server.addEventInterceptor((client, event, args) -> {
    return true; // 許可
});

検証、フィルタリング、またはセキュリティチェックに使用されます。

すべてのイベントリスナーを削除

server.removeAllListeners("eventName");

接続ライフサイクルリスナー

接続リスナー

server.addConnectListener(client -> {
    System.out.println("接続されました: " + client.getSessionId());
});

切断リスナー

server.addDisconnectListener(client -> {
    System.out.println("切断されました");
});

Ping / Pong リスナー

server.addPingListener(client -> {});
server.addPongListener(client -> {});

接続の健全性を監視するのに役立ちます。

リスナーの自動登録

リスナーオブジェクトを登録

server.addListeners(new ChatEventHandler());

明示的なクラスで登録

server.addListeners(new ChatEventHandler(), ChatEventHandler.class);

アノテーションベースのリスナーをサポートします。

確認 イベント 詳細については