-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnew-project.html
More file actions
1128 lines (919 loc) · 51.2 KB
/
new-project.html
File metadata and controls
1128 lines (919 loc) · 51.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>新規開発環境 | SOCKET-MANAGER Framework For PHP</title>
<meta name="description" content="SOCKET-MANAGERフレームワークの新規開発環境の構築手順を解説。初期化クラス、プロトコルUNIT、コマンドUNITの実装方法からデモプロジェクトの例まで、具体的なコード例と共に紹介。" />
<meta content="PHP,ソケット通信,フレームワーク,サーバー開発,ソケットマネージャー" name="keywords">
<link rel="canonical" href="https://socket-manager.github.io/document/new-project.html" />
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LF9W695NNW"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-LF9W695NNW');
</script>
<link rel="icon" href="https://socket-manager.github.io/document/favicon.ico" type="image/x-icon" />
<link type="text/css" rel="stylesheet" href="./css/common.css" media="all" />
<script src="./js/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="./js/common.js"></script>
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "SOCKET-MANAGER Framework - 新規開発環境構築ガイド",
"description": "SOCKET-MANAGERフレームワークの新規開発環境の構築手順を解説。初期化クラス、プロトコルUNIT、コマンドUNITの実装方法からデモプロジェクトの例まで、具体的なコード例と共に紹介。",
"keywords": "PHP, ソケット通信, フレームワーク, 新規開発環境, ソケットマネージャー",
"articleSection": ["Technical Documentation", "Server Development", "PHP Programming"],
"author": {
"@type": "Person",
"name": "SOCKET-MANAGER開発チーム"
},
"publisher": {
"@type": "Organization",
"name": "SOCKET-MANAGER",
"logo": {
"@type": "ImageObject",
"url": "https://socket-manager.github.io/document/logo.png",
"width": 355,
"height": 50
}
},
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://socket-manager.github.io/document/new-project.html"
},
"url": "https://socket-manager.github.io/document/new-project.html",
"breadcrumb": {
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "Framework Top",
"item": "https://socket-manager.github.io/document/"
},{
"@type": "ListItem",
"position": 2,
"name": "新規開発環境",
"item": "https://socket-manager.github.io/document/new-project.html"
}]
},
"isPartOf": {
"@type": "WebSite",
"name": "フレームワークのご紹介",
"url": "https://socket-manager.github.io/document/"
}
}
</script>
</head>
<body>
<div class="layout">
<div class="menu" role="navigation" aria-label="ページメニュー">
<h2 class="menu-title">SOCKET-MANAGER</h2>
<h4 class="menu-reference menu-page-title-bottom"><a href="./reference/" target="_blank">>> Reference</a></h4>
<h2 class="menu-label">MAIN-MENU</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./">▶フレームワークのご紹介</a></h3>
<h3 class="menu-page-title-link"><a href="./event-handler.html">▶イベントハンドラについて</a></h3>
</div>
<h3 class="menu-label-sub">IMPLEMENT</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./init-class.html">▶初期化クラス</a></h3>
<h3 class="menu-page-title-link"><a href="./unit-parameter.html">▶UNITパラメータクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./protocol-unit.html">▶プロトコルUNITクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./command-unit.html">▶コマンドUNITクラス</a></h3>
<h3 class="menu-page-title-link"><a href="./main.html">▶メイン処理クラス</a></h3>
<h3 class="menu-page-title-link"><a href="./setting.html">▶設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./message.html">▶メッセージファイル</a></h3>
</div>
<div class="menu-line"></div>
<div class="menu-text">
<h3 class="menu-page-title-link-for-runtime-manager"><a href="./runtime-manager/" target="_blank">>> ランタイムライブラリ</a></h3>
<h3 class="menu-page-title-link-for-runtime-manager"><a href="./simple-socket/" target="_blank">>> シンプルソケット機能</a></h3>
</div>
<h3 class="menu-label-sub">ADVANCED</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./concept.html">▶設計コンセプト</a></h3>
<h3 class="menu-page-title-link"><a href="./architecture.html">▶アーキテクチャ</a></h3>
<h3 class="menu-page-title-link"><a href="./communication.html">▶通信抽象化</a></h3>
<h3 class="menu-page-title-link"><a href="./union.html">▶共有基盤</a></h3>
<h3 class="menu-page-title-link"><a href="./event.html">▶イベント駆動アーキテクチャ</a></h3>
<h3 class="menu-page-title-link"><a href="./ipc.html">▶IPC（プロセス間通信）</a></h3>
<h3 class="menu-page-title-link"><a href="./multi-server.html">▶マルチサーバーの構成</a></h3>
<h3 class="menu-page-title-link"><a href="./tcp-and-udp.html">▶TCP/UDP通信について</a></h3>
<h3 class="menu-page-title-link"><a href="./laravel.html">▶Laravelと連携する</a></h3>
<h3 class="menu-page-title-link"><a href="./system-setting.html">▶システム設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./custom-command.html">▶カスタムコマンド作成機能</a></h3>
<h3 class="menu-page-title-link"><a href="./high-performance.html">▶ハイパフォーマンスモード</a></h3>
<h3 class="menu-page-title-link"><a href="./scale-test.html">▶実運用スケールベンチマーク</a></h3>
<h3 class="menu-page-title-link"><a href="./itil.html">▶技術版 ITIL としての CUEI/O</a></h3>
</div>
<h3 class="menu-label-sub">OTHER-PROJECT</h3>
<div class="menu-text">
<h3 class="menu-page-title">▼新規開発環境</h3>
<ul>
<li><a href="./new-project.html#begin">はじめに</a></li>
</ul>
<ul>
<li><a href="./new-project.html#install">インストール</a></li>
</ul>
<ul>
<li><a href="./new-project.html#init">初期化クラスの実装</a></li>
</ul>
<ul>
<li><a href="./new-project.html#protocol">プロトコル部の実装</a></li>
</ul>
<ul>
<li><a href="./new-project.html#command">コマンド部の実装</a></li>
</ul>
<ul>
<li><a href="./new-project.html#status-name">予約済ステータス</a></li>
</ul>
<ul>
<li><a href="./new-project.html#unit-parameter">UNITパラメータの実装</a></li>
</ul>
<ul>
<li><a href="./new-project.html#main">メイン処理クラスの実装</a></li>
</ul>
<ul>
<li><a href="./new-project.html#setting">設定ファイルの作成</a></li>
</ul>
<ul>
<li><a href="./new-project.html#locale">メッセージファイルの作成</a></li>
</ul>
<ul>
<li><a href="./new-project.html#last">おわりに</a></li>
</ul>
<h3 class="menu-page-title-link"><a href="./websocket.html">▶Websocketサーバー開発環境</a></h3>
<h3 class="menu-page-title-link"><a href="./dev-ops.html">▶フレームワークのDevOps環境</a></h3>
</div>
<div class="menu-line"></div>
<div class="menu-text">
<h3 class="menu-page-title-link-for-minecraft"><a href="./minecraft-contents/" target="_blank">>> マインクラフト専用環境</a></h3>
<h3 class="menu-page-title-link-for-launcher"><a href="./launcher/" target="_blank">>> GUI & CLI ランチャー</a></h3>
<h3 class="menu-page-title-link-for-rest-api"><a href="./rest-api/" target="_blank">>> REST-APIサーバー開発環境</a></h3>
</div>
<h2 class="menu-label">EXTRA-MENU</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./extra-demo.html">▶デモサーバーの種類</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-demo-command.html">▶デモのコマンド仕様</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-demo-setting.html">▶デモの設定ファイル</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-minecraft.html">▶マインクラフトの通信仕様</a></h3>
<h3 class="menu-page-title-link"><a href="./extra-close-frame.html">▶切断フレームの検証</a></h3>
</div>
<h2 class="menu-label">PHP-TECHNIQUE</h2>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./php-pass-by-reference.html">▶参照渡し</a></h3>
<h3 class="menu-page-title-link"><a href="./php-phpdoc.html">▶PHPDocのフォーマット</a></h3>
</div>
<div class="menu-dummy-for-framework"></div>
</div>
<div class="main" role="main">
<h1>【新規開発環境】</h1>
<a id="begin"></a>
<h2 class="subtitle">はじめに</h2>
<div class="text-block">
新規プロジェクトで開発を行う場合は、開発のターゲットとなるプロトコルの知識が必要になります。<br/>
また<font><a href="./architecture.html" target="_blank">▶アーキテクチャ</a></font>のページをご覧になった上で進めていただいた方が用語の理解も含めてより効率的に進められます。<br /><br />
ここではデモ版のソースを例に挙げながら<code>php worker</code>コマンドを使って新規のクラスを作っていきます。<br />
デモ版のソースを参考にしつつ、ある程度処理の流れを掴んでから進めていくのがスムーズかと思います。
</div><br />
<a id="install"></a>
<h2 class="subtitle">インストール</h2>
<div class="text-block">
以下のコマンドでインストールできます。<br />
※GitHubから直接ダウンロードする場合は<font><a href="https://github.com/socket-manager/new-project" target="_blank">>> こちら</a></font>からどうぞ。<br />
<pre color-change="command" aria-label="新規開発環境のインストール">
> composer create-project socket-manager/new-project <インストール先のディレクトリ名>
</pre><br />
インストールが完了すると以下のディレクトリ構成になります。<br />
<pre aria-label="プロジェクトの構成">
/app
/InitClass 初期化クラス
/UnitParameter UNITパラメータクラス
/ProtocolUnits プロトコルUNIT定義クラス
/CommandUnits コマンドUNIT定義クラス
/MainClass メイン処理クラス
/logs ログ出力用
/setting 設定ファイル用
</pre><br />
<code>php worker</code>コマンドを実行すると以下のようなUsageが表示されます。<br />
<pre color-change="command" aria-label="Usage表示">
> php worker
SOCKET-MANAGER Framework 1.X.X
Usage:
command [arguments]
main
Empty...
craft
craft:init <初期化クラス名> 初期化クラスの生成
craft:parameter <UNITパラメータクラス名> UNITパラメータクラスの生成
craft:protocol <プロトコルUNIT定義のクラス名> プロトコルUNIT定義のクラスとステータス名Enumの生成
craft:command <コマンドUNIT定義のクラス名> コマンドUNIT定義のクラスとキュー／ステータス名Enumの生成
craft:main <メイン処理のクラス名> メイン処理クラスの生成
craft:setting <設定ファイル名> 設定ファイルの生成
craft:locale <メッセージファイル名> メッセージファイルの生成
runtime
runtime:init <初期化クラス名> 初期化クラスの生成
runtime:parameter <UNITパラメータクラス名> UNITパラメータクラスの生成
runtime:units <ランタイムUNIT定義のクラス名> ランタイムUNIT定義のクラスとキュー／ステータス名Enumの生成
runtime:main <メイン処理のクラス名> メイン処理クラスの生成
simple
simple:tcp-server <メイン処理のクラス名> TCPサーバー用メイン処理クラスの生成
simple:tcp-client <メイン処理のクラス名> TCPクライアント用メイン処理クラスの生成
simple:udp <メイン処理のクラス名> UDP通信用メイン処理クラスの生成
</pre>
※<code>laravel:command</code>コマンドに関してはLaravel環境でしか表示されません。<br /><br />
それでは動作確認のため、以下のコマンドを実行してメイン処理クラスを作成します。<br />
今回は<code>MainForTest</code>という名前で作成します。<br /><br />
以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="MainForTestクラス作成">
> php worker craft:main MainForTest
[success] メイン処理クラスの生成に成功しました (MainForTest)
</pre><br />
再度<code>php worker</code>を実行してみます。<br />
<pre color-change="command" aria-label="Usage表示">
> php worker
SOCKET-MANAGER Framework 1.X.X
Usage:
command [arguments]
main
app:main-for-test Command description
craft
craft:init <初期化クラス名> 初期化クラスの生成
craft:parameter <UNITパラメータクラス名> UNITパラメータクラスの生成
craft:protocol <プロトコルUNIT定義のクラス名> プロトコルUNIT定義のクラスとステータス名Enumの生成
craft:command <コマンドUNIT定義のクラス名> コマンドUNIT定義のクラスとキュー／ステータス名Enumの生成
craft:main <メイン処理のクラス名> メイン処理クラスの生成
craft:setting <設定ファイル名> 設定ファイルの生成
craft:locale <メッセージファイル名> メッセージファイルの生成
runtime
runtime:init <初期化クラス名> 初期化クラスの生成
runtime:parameter <UNITパラメータクラス名> UNITパラメータクラスの生成
runtime:units <ランタイムUNIT定義のクラス名> ランタイムUNIT定義のクラスとキュー／ステータス名Enumの生成
runtime:main <メイン処理のクラス名> メイン処理クラスの生成
simple
simple:tcp-server <メイン処理のクラス名> TCPサーバー用メイン処理クラスの生成
simple:tcp-client <メイン処理のクラス名> TCPクライアント用メイン処理クラスの生成
simple:udp <メイン処理のクラス名> UDP通信用メイン処理クラスの生成
</pre><br />
アプリ名<code>main-for-test</code>という名前で登録されている事が確認できます。<br />
まずは以下のコマンドを実行して今回作成したサーバーを起動した状態にしてください。<br />
<pre color-change="command" aria-label="サーバー起動">
> php worker app:main-for-test 10000
</pre><br />
その後PowerShellなどで以下のように<code>netstat</code>コマンドを実行して10000ポートがListenされている事が確認できれば正常にインストールされています。<br />
<pre color-change="command" aria-label="Listenポート確認">
> netstat -ano | Select-String -Pattern "127.0.0.1:10000"
TCP 127.0.0.1:10000 0.0.0.0:0 LISTENING 21536
</pre><br />
以降の説明ではデモの中で一番オーソドックスなWebsocket版チャットサーバーを例に取り上げて話を進めます。
</div><br />
<a id="init"></a>
<h2 class="subtitle">初期化クラスの実装</h2>
<div class="text-block">
初期化クラスのソースは以下のコマンドで作成できます。<br />
<code>InitForTest</code>という名前で作成する場合、以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="初期化クラスの作成">
> php worker craft:init InitForTest
[success] 初期化クラスの生成に成功しました (InitForTest)
</pre>
<pre aria-label="生成されるファイル">
/app
/InitClass
<font class="pre-yellow">InitForTest.php</font>
</pre><br />
それでは以下のWebsocket版チャットサーバーのソースをご覧ください。<br />
<pre color-change="php" aria-label="app/InitClass/InitForWebsocket.php">
class InitForWebsocket implements IInitSocketManager
{
.
.
.
/**
* ログライターの取得
*
* nullを返す場合は無効化（但し、ライブラリ内部で出力されているエラーメッセージも出力されない）
*
* @return mixed "function(string $p_level, array $p_param): void" or null（ログ出力なし）
*/
public function getLogWriter()
{
return function(string $p_level, array $p_param)
{
.
.
.
};
}
/**
* シリアライザーの取得
*
* nullを返す場合は無効化となる。
* エラー発生時はUnitExceptionクラスで例外をスローして切断する。
*
* @return mixed "function(mixed $p_data): mixed" or null（変更なし）
*/
public function getSerializer()
{
return function($p_data)
{
.
.
.
};
}
/**
* アンシリアライザーの取得
*
* nullを返す場合は無効化となる。
* エラー発生時はUnitExceptionクラスで例外をスローして切断する。
*
* @return mixed "function(mixed $p_data): mixed" or null（変更なし）
*/
public function getUnserializer()
{
return function($p_data)
{
.
.
.
};
}
/**
* コマンドディスパッチャーの取得
*
* 受信データからコマンドを解析して返す
*
* コマンドUNIT実行中に受信データが溜まっていた場合でもコマンドUNITの処理が完了するまで
* 待ってから起動されるため処理競合の調停役を兼ねる
*
* nullを返す場合は無効化となる。エラー発生時はUnitExceptionクラスで例外をスローして切断する。
*
* @return mixed "function(SocketManagerParameter $p_param, mixed $p_dat): ?string" or null（変更なし）
*/
public function getCommandDispatcher()
{
return function(ParameterForWebsocket $p_param, $p_dat): ?string
{
.
.
.
};
}
/**
* 緊急停止時のコールバックの取得
*
* 例外等の緊急切断時に実行される。nullを返す場合は無効化となる。
*
* @return mixed "function(SocketManagerParameter $p_param)"
*/
public function getEmergencyCallback()
{
return function(ParameterForWebsocket $p_param)
{
.
.
.
};
}
/**
* UNITパラメータインスタンスの取得
*
* nullの場合はSocketManagerParameterのインスタンスが適用される
*
* @return ?SocketManagerParameter SocketManagerParameterクラスのインスタンス（※1）
* @see:RETURN （※1）当該クラス、あるいは当該クラスを継承したクラスも指定可
*/
public function getUnitParameter(): ?SocketManagerParameter
{
.
.
.
}
}
</pre><br />
ここで必須になる実装は大きく分けると以下の７点になります。<br />
各々のメソッドはnullを返す事で無効化できます。<br />
<dl>
<dt>■IInitSocketManagerのインプリメント</dt>
<dd>ライブラリが以下に記載のハンドラーの取り込み時に利用する。</dd>
<dt>■getLogWriterメソッドの実装</dt>
<dd>
ライブラリ内でのログ出力に利用。<br />
ハンドラーにする事で<code>error_log</code>関数やフレームワークの<code>Logger</code>等の利用が可能。
</dd>
<dt>■getSerializerメソッドの実装</dt>
<dd>
送受信スタック内ペイロードデータのシリアライズ時に利用する。<br />
今回のデモではJSONエンコード時に利用。
</dd>
<dt>■getUnserializerメソッドの実装</dt>
<dd>
送受信スタック内ペイロードデータのアンシリアライズ時に利用する。<br />
今回のデモではJSONデコード時に利用。
</dd>
<dt>■getCommandDispatcherメソッドの実装</dt>
<dd>クライアントから受信したペイロード部を解析して対応するコマンドキュー名を返す。</dd>
<dt>■getEmergencyCallbackメソッドの実装</dt>
<dd>
相手先による切断・コマンドディスパッチャーでの例外発生・アライブチェックタイムアウトなどの緊急停止時にコールされる。
</dd>
<dt>■getUnitParameterメソッドの実装</dt>
<dd>UNITパラメータとして利用される。グローバルエリアの管理が必要ないのであれば<code>SocketManagerParameter</code>クラスをそのまま使っても構わない。</dd>
</dl>
※ 初期化クラスの実装内容の詳細については<font><a href="./init-class.html">▶初期化クラス</a></font>のページをご覧ください。<br />
</div><br />
<a id="protocol"></a>
<h2 class="subtitle">プロトコル部の実装</h2>
<div class="text-block">
プロトコル部のソースは以下のコマンドで作成できます。<br />
<code>ProtocolForTest</code>という名前で作成する場合、以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="プロトコル部の作成">
> php worker craft:protocol ProtocolForTest
[success] プロトコルUNITクラスの生成に成功しました (ProtocolForTest)
[success] プロトコルUNITのキュー名Enumの生成に成功しました (ProtocolForTestQueueEnum)
[success] プロトコルUNITのステータス名Enumの生成に成功しました (ProtocolForTestStatusEnum)
</pre>
<pre aria-label="生成されるファイル">
/app
/ProtocolUnits
<font class="pre-yellow">ProtocolForTest.php</font>
<font class="pre-yellow">ProtocolForTestQueueEnum.php</font>
<font class="pre-yellow">ProtocolForTestStatusEnum.php</font>
</pre><br />
この部分の実装は主にソケットプロトコルに関係する送受信の処理を行うところで、実際の通信処理はこのプロトコル部で行います。<br />
それでは以下のWebsocket版チャットサーバーのソースをご覧ください。<br />
<pre color-change="php" aria-label="Websocket版チャットサーバーのソース：app/ProtocolUnits/ProtocolForWebsocket.php">
class ProtocolForWebsocket implements IEntryUnits
{
// キューリスト
protected const QUEUE_LIST = [
ProtocolQueueEnum::ACCEPT->value, // アクセプトを処理するキュー
ProtocolQueueEnum::RECV->value, // 受信処理のキュー
ProtocolQueueEnum::SEND->value, // 送信処理のキュー
ProtocolQueueEnum::CLOSE->value, // 切断処理のキュー
ProtocolQueueEnum::ALIVE->value // アライブチェック処理のキュー
];
/**
* キューリストの取得
*
* @return array キュー名のリスト
*/
public function getQueueList(): array
{
return self::QUEUE_LIST;
}
/**
* ステータスUNITリストの取得
*
* @param string $p_que キュー名
* @return array キュー名に対応するUNITリスト
*/
public function getUnitList(string $p_que): array
{
$ret = [];
if($p_que === ProtocolQueueEnum::ACCEPT->value)
{
$ret[] = [
'status' => ProtocolStatusEnumForWebsocket::START->value,
'unit' => $this->getAcceptStart()
];
$ret[] = [
'status' => ProtocolStatusEnumForWebsocket::CREATE->value,
'unit' => $this->getAcceptCreate()
];
$ret[] = [
'status' => ProtocolStatusEnumForWebsocket::SEND->value,
'unit' => $this->getAcceptSend()
];
}
.
.
.
return $ret;
}
.
.
.
/**
* ステータス名： START
*
* 処理名：受信
*
* @param ParameterForWebsocket $p_param UNITパラメータ
* @return ?string 遷移先のステータス名
*/
protected function getAcceptStart()
{
return function(ParameterForWebsocket $p_param): ?string
{
.
.
.
};
}
.
.
.
}
</pre><br />
ここで必須になる実装は大きく分けると以下の４点になります。
<dl>
<dt>■IEntryUnitsのインプリメント</dt>
<dd>ライブラリがプロトコル部の取り込み時に利用する</dd>
<dt>■getQueueListメソッドの実装</dt>
<dd>プロトコル部で利用するキューのリストを返す</dd>
<dt>■getUnitListメソッドの実装</dt>
<dd>引数のキュー名に対応するUNITのリストを返す</dd>
<dt>■各UNITの実装</dt>
<dd><code>getUnitList</code>メソッドで返している定義済みのUNIT処理を実装</dd>
</dl>
UNIT本体の処理は上記の場合<code>getAcceptStart</code>メソッドでクロージャとして返していますが、グローバル関数名を指定する事も可能です。<br /><br />
※プロトコル部で利用するキュー名は全てライブラリ側の<code>ProtocolQueueEnum</code>クラスで予約されています。<br />
<pre color-change="php" aria-label="プロトコル部の予約済Enum定義：ProtocolQueueEnum.php">
enum ProtocolQueueEnum: string
{
/**
* @var アクセプト時のキュー名
*/
case ACCEPT = 'accept';
/**
* @var コネクション時のキュー名
*/
case CONNECT = 'connect';
/**
* @var 受信時のキュー名
*/
case RECV = 'recv';
/**
* @var 送信時のキュー名
*/
case SEND = 'send';
/**
* @var 切断時のキュー名
*/
case CLOSE = 'close';
/**
* @var アライブチェック時のキュー名
*/
case ALIVE = 'alive';
}
</pre><br />
必ずしも全てのキュー名を使用する必要はありませんがサーバーサイドのWebsocketの規約では<code>CONNECT</code>を除いて全てルール化されています。<br /><br />
※ プロトコルUNITクラスの実装内容の詳細については<font><a href="./protocol-unit.html">▶プロトコルUNITクラス</a></font>のページをご覧ください。<br />
</div><br />
<a id="command"></a>
<h2 class="subtitle">コマンド部の実装</h2>
<div class="text-block">
コマンド部のソースは以下のコマンドで作成できます。<br />
<code>CommandForTest</code>という名前で作成する場合、以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="コマンド部の作成">
> php worker craft:command CommandForTest
[success] コマンドUNITクラスの生成に成功しました (CommandForTest)
[success] コマンドUNITのキュー名Enumの生成に成功しました (CommandForTestQueueEnum)
[success] コマンドUNITのステータス名Enumの生成に成功しました (CommandForTestStatusEnum)
</pre>
<pre aria-label="生成されるファイル">
/app
/CommandUnits
<font class="pre-yellow">CommandForTest.php</font>
<font class="pre-yellow">CommandForTestQueueEnum.php</font>
<font class="pre-yellow">CommandForTestStatusEnum.php</font>
</pre><br />
プロトコル部が通信を担う部分であるのに対して、コマンド部ではクライアント側とコマンド単位でのデータのやり取りを行って、コマンドの解釈とその内容に応じたレスポンスを返す部分になります。<br /><br />
まずは以下のWebsocket版チャットサーバーのソースをご覧ください。<br />
<pre color-change="php" aria-label="Websocket版チャットサーバーのソース：app/CommandUnits/CommandForWebsocket.php">
/**
* コマンドUNIT登録クラス
*
* IEntryUnitsインターフェースをインプリメントする
*/
class CommandForWebsocket implements IEntryUnits
{
// キューリスト
protected const QUEUE_LIST = [
CommandQueueEnumForWebsocket::ENTRANCE->value, // entranceコマンドを処理するキュー
CommandQueueEnumForWebsocket::MESSAGE->value, // messageコマンドを処理するキュー
CommandQueueEnumForWebsocket::EXIT->value, // exitコマンドを処理するキュー
CommandQueueEnumForWebsocket::CLOSE->value, // closeコマンドを処理するキュー
CommandQueueEnumForWebsocket::PRIVATE->value, // privateコマンドを処理するキュー
CommandQueueEnumForWebsocket::PRIVATE_RESULT->value, // private-resultコマンドを処理するキュー
CommandQueueEnumForWebsocket::USERSEARCH_RESULT->value // usersearch-resultコマンドを処理するキュー
];
/**
* キューリストの取得
*
* @return array キュー名のリスト
*/
public function getQueueList(): array
{
return static::QUEUE_LIST;
}
/**
* ステータスUNITリストの取得
*
* @param string $p_que キュー名
* @return array キュー名に対応するUNITリスト
*/
public function getUnitList(string $p_que): array
{
$ret = [];
if($p_que === CommandQueueEnumForWebsocket::ENTRANCE->value)
{
$ret[] = [
'status' => CommandStatusEnumForWebsocket::START->value,
'unit' => $this->getEntranceStart()
];
}
.
.
.
}
.
.
.
/**
* ステータス名： START
*
* 処理名：入室処理開始
*
* @param ParameterForWebsocket $p_param UNITパラメータ
* @return ?string 遷移先のステータス名
*/
protected function getEntranceStart()
{
return function(ParameterForWebsocket $p_param): ?string
{
.
.
.
}
}
.
.
.
}
</pre><br />
構成内容はプロトコル部とほぼ同じで、必須になる実装も大きく分けると以下の４点になります。<br />
<dl>
<dt>■IEntryUnitsのインプリメント</dt>
<dd>ライブラリがコマンド部の取り込み時に利用する</dd>
<dt>■getQueueListメソッドの実装</dt>
<dd>コマンド部で利用するキューのリストを返す</dd>
<dt>■getUnitListメソッドの実装</dt>
<dd>引数のキュー名に対応するUNITのリストを返す</dd>
<dt>■各UNITの実装</dt>
<dd><code>getUnitList</code>メソッドで返している定義済みのUNIT処理を実装</dd>
</dl>
UNIT本体の処理は上記の場合<code>getEntranceStart</code>メソッドでクロージャとして返していますが、グローバル関数名を指定する事も可能です。<br /><br />
※ コマンド部で利用するキュー名は自由定義です。特に予約されているものもありません。<br />
※ コマンドUNITクラスの実装内容の詳細については<font><a href="./command-unit.html">▶コマンドUNITクラス</a></font>のページをご覧ください。<br />
</div><br />
<a id="status-name"></a>
<h2 class="subtitle">予約済ステータス</h2>
<div class="text-block">
予約されているものは以下ライブラリ側のEnum定義のみです。<br />
<pre color-change="php" aria-label="予約済Enum定義：StatusEnum.php">
enum StatusEnum: string
{
/**
* @var UNITの処理開始時のステータス名
*/
case START = 'start';
}
</pre><br />
プロトコル／コマンド部共通で利用するSTART（処理開始）のみになります。
</div><br />
<a id="unit-parameter"></a>
<h2 class="subtitle">UNITパラメータの実装</h2>
<div class="text-block">
UNITパラメータクラスのソースは以下のコマンドで作成できます。<br />
<code>ParameterForTest</code>という名前で作成する場合、以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="UNITパラメータクラスの作成">
> php worker craft:parameter ParameterForTest
[success] UNITパラメータクラスの生成に成功しました (ParameterForTest)
</pre>
<pre aria-label="生成されるファイル">
/app
/UnitParameter
<font class="pre-yellow">ParameterForTest.php</font>
</pre><br />
ここで述べているUNITパラメータというのはプロトコル部やコマンド部で定義されているUNITの引数の部分です。<br />
上記のプロトコル部やコマンド部の例でいえば<code>ParameterForWebsocket $p_param</code>の部分になります。<br />
この引数には<code>SocketManagerParameter</code>クラスを継承しているものであれば何を指定しても構いません。<br /><br />
グローバルエリアを使う必要がなければ特に実装する事は何もありませんが、新規で作成した場合は以下のようにUNIT処理の引数の部分を必要に応じて置き替えてください。<br />
<pre color-change="php" aria-label="修正前：黄色部分（プロトコル部のデフォルト）">
protected function getAcceptStart()
{
return function(<font class="pre-yellow">SocketManagerParameter</font> $p_param): ?string
{
$p_param->logWriter('debug', ['ACCEPT' => 'START']);
return null;
};
}
</pre>
<pre color-change="php" aria-label="修正後：赤色部分（新規で作成したクラス）">
protected function getAcceptStart()
{
return function(<font class="pre-red">ParameterForTest</font> $p_param): ?string
{
$p_param->logWriter('debug', ['ACCEPT' => 'START']);
return null;
};
}
</pre><br />
※ UNITパラメータクラスの実装内容の詳細については<font><a href="./unit-parameter.html">▶UNITパラメータクラス</a></font>のページをご覧ください。<br />
</div><br />
<a id="main"></a>
<h2 class="subtitle">メイン処理クラスの実装</h2>
<div class="text-block">
メイン処理クラスのソースは以下のコマンドで作成できます。<br />
<code>MainForTest</code>という名前で作成する場合、以下のように表示されれば成功です。<br />
<pre color-change="command" aria-label="メイン処理クラスの作成">
> php worker craft:main MainForTest
[success] メイン処理クラスの生成に成功しました (MainForTest)
</pre>
<pre aria-label="生成されるファイル">
/app
/MainClass
<font class="pre-yellow">MainForTest.php</font>
</pre><br />
生成されたソースは次の通り。<br />
<pre color-change="php" aria-label="app/MainClass/MainForTest.php">
class MainForTest extends Console
{
/**
* @var string $identifer サーバー識別子
*/
protected string $identifer = 'app:main-for-test {port_no?}';
/**
* @var string $description コマンド説明
*/
protected string $description = 'Command description';
/**
* サーバー起動
*
*/
public function exec()
{
// 引数の取得
$port_no = $this->getParameter('port_no');
// ソケットマネージャーのインスタンス設定
$manager = new SocketManager('localhost', $port_no);
/***********************************************************************
* ソケットマネージャーの初期設定
*
* プロトコル／コマンド部等で実装したクラスのインスタンスをここで設定します
**********************************************************************/
/**
* 初期化クラスの設定
*
* $manager->setInitSocketManager()メソッドで初期化クラスを設定します
*/
/**
* プロトコルUNITの設定
*
* $manager->setProtocolUnits()メソッドでプロトコルUNITクラスを設定します
*/
/**
* コマンドUNITの設定
*
* $manager->setCommandUnits()メソッドでコマンドUNITクラスを設定します
*/
/***********************************************************************
* ソケットマネージャーの実行
*
* ポートの待ち受け処理や周期ドリブン処理を実行します
**********************************************************************/
// リッスンポートで待ち受ける
$ret = $manager->listen();
if($ret === false)
{
goto finish; // リッスン失敗
}
// ノンブロッキングループ
while(true)
{
// 周期ドリブン
$ret = $manager->cycleDriven();
if($ret === false)
{
goto finish;
}
}
finish:
// 全接続クローズ
$manager->shutdownAll();
}
}
</pre><br />
ここで必須になる実装は初期設定ブロックである以下の３点になります。<br />
<dl>
<dt>■初期化クラスの設定</dt>
<dd>初期化クラスのインスタンスを生成し、<code>SocketManager</code>クラスの<code>setInitSocketManager</code>メソッドにインスタンスを引き渡す</dd>
<dt>■プロトコルUNITの設定</dt>
<dd>プロトコルUNITクラスのインスタンスを生成し、<code>SocketManager</code>クラスの<code>setProtocolUnits</code>メソッドにインスタンスを引き渡す</dd>
<dt>■コマンドUNITの設定</dt>
<dd>コマンドUNITクラスのインスタンスを生成し、<code>SocketManager</code>クラスの<code>setCommandUnits</code>メソッドにインスタンスを引き渡す</dd>
</dl>
※ メイン処理クラスの実装内容の詳細については<font><a href="./main.html">▶メイン処理クラス</a></font>のページをご覧ください。<br />
</div><br />
<a id="setting"></a>
<h2 class="subtitle">設定ファイルの作成</h2>
<div class="text-block">
設定ファイルは以下のコマンドで作成できます。<br />
<code>test</code>という名前で作成する場合、以下のように表示されれば成功です。<br />