Skip to content

Commit d1457a4

Browse files
v1.50.1 Release
README文書の校正
1 parent 071bc77 commit d1457a4

1 file changed

Lines changed: 49 additions & 5 deletions

File tree

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# SOCKET-MANAGER Framework:高機能ソケット通信アプリ開発のための総合ガイド
2-
**REST-API / RESTful-API サーバー開発にも正式対応**
2+
**REST-API / RESTful-API サーバー開発にも正式対応**
3+
**IPC(プロセス間通信)・カスタムコマンド作成機能にも対応**
34

45
SOCKET-MANAGER Frameworkは、WebSocketやTCP/UDPといったリアルタイム通信に加え、
56
**REST-API / RESTful-API サーバー開発にも対応したオープンソースフレームワーク**です。
67
フレームワーク本体には **ビルトインのステートマシン**が搭載されており、
78
リアルタイム通信だけでなく、Chunked Transfer・SSE・Range送信など、
89
REST-API で必要となる分割送信や状態遷移を伴う処理も効率的に実装できます。
910

11+
さらに、**IPC(プロセス間通信)****カスタムコマンド作成機能** により、
12+
マルチサーバー構成やプロジェクト固有のスキャフォールディングにも柔軟に対応できます。
13+
1014
---
1115

1216
## 【 概要 】
1317
SOCKET-MANAGERは、リアルタイム通信を伴うサービス(チャット、ゲーム連携、通知システムなど)に加え、
1418
**REST-API / RESTful-API を含む Web API 開発**にも対応したフレームワークです。
15-
PSR-7準拠のHTTPメッセージ処理、イベントハンドラ、ステートマシンを統合し
19+
PSR-7準拠のHTTPメッセージ処理、イベントハンドラ、ステートマシン、IPC(プロセス間通信)を統合し
1620
高速・柔軟・拡張性の高いアプリケーション開発を支援します。
1721

1822
---
@@ -21,6 +25,8 @@ PSR-7準拠のHTTPメッセージ処理、イベントハンドラ、ステー
2125
- WebSocket、TCP/UDPを利用したリアルタイム通信の実装テンプレート
2226
- **REST-API / RESTful-API サーバー開発環境(PSR-7準拠)**
2327
- **ステートマシンを利用したChunked Transfer / SSE / Range送信などの状態遷移処理**
28+
- **IPC(プロセス間通信)によるマルチサーバー連携・プロセス間メッセージング**
29+
- **カスタムコマンド作成機能によるプロジェクト固有のスキャフォールディング**
2430
- 初期化クラス、UNITパラメータ、プロトコル/コマンドUNITなどの実装ガイド
2531
- マルチサーバー構成やスケールを見据えたアーキテクチャ解説
2632
- マインクラフトと連携するデモ環境、コマンド仕様、設定例
@@ -46,9 +52,42 @@ https://github.com/socket-manager/rest-api/
4652

4753
---
4854

55+
## 【 IPC(プロセス間通信)について 】
56+
SOCKET-MANAGER Framework は、TCP/UDP/WebSocket などの通信方式を
57+
**同一プロセス内で共存させるアーキテクチャ**を採用しており、
58+
IPC を特別扱いせず自然に実現できます。
59+
60+
- TCP / UDP / WebSocket を組み合わせたプロセス間通信
61+
- Webブラウザ同士の宛先指定メッセージング
62+
- Webブラウザ ⇔ Minecraft 統合版(Bedrock Edition)の双方向通信
63+
- マルチサーバー構成との親和性
64+
- Launcher による統合管理(CUEI/O の “/O” に該当)
65+
66+
詳細はこちら:
67+
https://socket-manager.github.io/document/ipc.html
68+
69+
---
70+
71+
## 【 カスタムコマンド作成機能 】
72+
SOCKET-MANAGER Framework では、ビルトインコマンドに加えて
73+
**プロジェクト固有の CLI コマンドを自由に追加できる** 拡張機能を提供しています。
74+
75+
- command.php / params.php / template.php.tpl による簡易定義
76+
- プロジェクト固有のスキャフォールディング
77+
- REST API / IPC / ステートマシンユニットの雛形生成
78+
- チーム開発での共通タスク自動化
79+
80+
詳細はこちら:
81+
https://socket-manager.github.io/document/custom-command.html
82+
83+
---
84+
4985
## 【 ドキュメント(Reference) 】
5086
フルドキュメントはこちら(ホストされた参照ページ)
87+
5188
- フレームワーク紹介: https://socket-manager.github.io/document/
89+
- IPC(プロセス間通信): https://socket-manager.github.io/document/ipc.html
90+
- カスタムコマンド作成機能: https://socket-manager.github.io/document/custom-command.html
5291
- イベントハンドラ: https://socket-manager.github.io/document/event-handler.html
5392
- アーキテクチャ: https://socket-manager.github.io/document/architecture.html
5493
- マルチサーバー: https://socket-manager.github.io/document/multi-server.html
@@ -81,12 +120,18 @@ https://github.com/socket-manager/rest-api/
81120
---
82121

83122
## 【 実装ガイド(Implement) 】
84-
- 初期化クラスの実装: https://socket-manager.github.io/document/init-class.html
123+
- 初期化クラス: https://socket-manager.github.io/document/init-class.html
85124
- UNITパラメータ: https://socket-manager.github.io/document/unit-parameter.html
86-
- プロトコルUNIT / コマンドUNIT: https://socket-manager.github.io/document/protocol-unit.html / https://socket-manager.github.io/document/command-unit.html
125+
- プロトコルUNIT / コマンドUNIT:
126+
https://socket-manager.github.io/document/protocol-unit.html
127+
https://socket-manager.github.io/document/command-unit.html
87128
- メイン処理クラス: https://socket-manager.github.io/document/main.html
88129

130+
---
131+
89132
## 【 上級者向け(Advanced) 】
133+
- IPC(プロセス間通信): https://socket-manager.github.io/document/ipc.html
134+
- カスタムコマンド作成機能: https://socket-manager.github.io/document/custom-command.html
90135
- スケーラビリティとマルチサーバー設計: https://socket-manager.github.io/document/multi-server.html
91136
- TCP/UDP 詳細: https://socket-manager.github.io/document/tcp-and-udp.html
92137
- Laravel連携: https://socket-manager.github.io/document/laravel.html
@@ -118,4 +163,3 @@ https://github.com/socket-manager/rest-api/
118163
## 【 License 】
119164
本ドキュメントは Creative Commons Attribution 4.0 International (CC BY 4.0) の下で提供されています。
120165
詳細: https://creativecommons.org/licenses/by/4.0/
121-

0 commit comments

Comments
 (0)