Skip to content

socket-manager/document

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SOCKET-MANAGER Framework:高機能ソケット通信アプリ開発のための総合ガイド

REST-API / RESTful-API サーバー開発にも正式対応

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


【 概要 】

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


【 できること(特徴) 】

  • WebSocket、TCP/UDPを利用したリアルタイム通信の実装テンプレート
  • REST-API / RESTful-API サーバー開発環境(PSR-7準拠)
  • ステートマシンを利用したChunked Transfer / SSE / Range送信などの状態遷移処理
  • 初期化クラス、UNITパラメータ、プロトコル/コマンドUNITなどの実装ガイド
  • マルチサーバー構成やスケールを見据えたアーキテクチャ解説
  • マインクラフトと連携するデモ環境、コマンド仕様、設定例
  • PHP向けの技術ノウハウ(参照渡し、PHPDoc など)

【 REST-API / RESTful-API 対応について 】

SOCKET-MANAGER Framework は、REST-API / RESTful-API を構築するための
専用の開発環境(socket-manager/rest-api) を提供しています。

  • PSR-7準拠のリクエスト/レスポンス
  • イベントハンドラ型 / ステートマシン型の2種類の実装方式
  • Chunked Transfer、SSE、Range送信などの分割送信処理
  • IPC(サーバー間通信)を含む状態遷移処理
  • サンプルプロジェクトによる動作確認

特にステートマシン型は、通常のPHPアプリケーションでは困難な
確実な分割送信(Chunked Transfer)SSEの再接続処理 を自然に実装できます。

REST-API 開発環境はこちら:
https://github.com/socket-manager/rest-api/


【 ドキュメント(Reference) 】

フルドキュメントはこちら(ホストされた参照ページ)

(その他のページはサイト内のメニューを参照してください)


【 導入(Quick Start) 】

  1. 新規プロジェクトを展開: composer create-project socket-manager/new-project <展開先のディレクトリ名>
  2. メイン処理クラスを作成: php worker craft:main MainForTest
  3. サンプルプロジェクト(demo-project)を参考にローカルで動作確認

補足(WebSocketサーバー開発)

  • WebSocketサーバーを開発する場合は、専用プロジェクトを利用することを推奨します。WebSocket用の開発テンプレートと設定例を用意しています。

詳しい手順はドキュメント内の以下のページを参照してください

※ REST-API 開発の場合は以下を参照:
https://github.com/socket-manager/rest-api/


【 実装ガイド(Implement) 】

【 上級者向け(Advanced) 】


【 関連リポジトリ 】


【 Contact Us 】

バグ報告やご要望などはこちらから受け付けております。


【 License 】

本ドキュメントは Creative Commons Attribution 4.0 International (CC BY 4.0) の下で提供されています。
詳細: https://creativecommons.org/licenses/by/4.0/