-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.html
More file actions
681 lines (557 loc) · 39.8 KB
/
main.html
File metadata and controls
681 lines (557 loc) · 39.8 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
<!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フレームワークのメイン処理クラスの実装方法を解説。サーバー識別子の設定、マルチサーバー構成、TCP/UDP通信の実装例、サーバー間通信(IPC)の構築方法を具体的なコード例と共に紹介。" />
<meta content="PHP,ソケット通信,サーバー開発,framework,IPC,ソケットマネージャー" name="keywords">
<link rel="canonical" href="https://socket-manager.github.io/document/main.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フレームワークにおけるメイン処理クラスの実装方法を解説。サーバー識別子の設定、マルチサーバー構成、TCP/UDP通信の実装例、サーバー間通信(IPC)の構築方法を具体的なコード例と共に紹介。",
"keywords": "PHP, ソケット通信, メイン処理, マルチサーバー, IPC, ソケットマネージャー",
"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/main.html"
},
"url": "https://socket-manager.github.io/document/main.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/main.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">▼メイン処理クラス</h3>
<ul>
<li><a href="./main.html#begin">はじめに</a></li>
</ul>
<ul>
<li><a href="./main.html#identifier">サーバー識別子</a></li>
</ul>
<ul>
<li><a href="./main.html#description">コマンド説明文</a></li>
</ul>
<ul>
<li><a href="./main.html#setting">設定可能項目</a></li>
</ul>
<ul>
<li><a href="./main.html#class">クラス適用項目</a></li>
</ul>
<ul>
<li><a href="./main.html#ipc">サーバー間通信の構成</a></li>
</ul>
<ul>
<li><a href="./main.html#last">おわりに</a></li>
</ul>
<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="./architecture.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>
</div>
<h3 class="menu-label-sub">OTHER-PROJECT</h3>
<div class="menu-text">
<h3 class="menu-page-title-link"><a href="./new-project.html">▶新規開発環境</a></h3>
<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">
このクラスはサーバーのエントリポイントとして機能し、SocketManagerクラスをインスタンス化して実行するまでの処理が含まれています。<br />
専用のコマンドを使ってスキャフォールディングできるので、メイン処理をコーディングする必要はなく、プロトコル／コマンド（サーバーコンテンツ）部のクラスをパズルのように組み合わせて適用します。<br /><br />
このようにプロトコルやサーバーコンテンツを自由に組み替える事が可能なので、目的に合わせてサーバーデザインを自由にカスタマイズできます。<br />
この特性を活かして、一つのエントリポイント上でプロトコルが異なる複数のSocketManagerを配置する事により、外部ライブラリやサーバーを必要としないサーバー間通信（IPC）を使ったマルチサーバー環境の構築が、アーキテクチャレベルで実現できます。<br /><br />
ここではコマンドを実行してメイン処理クラスを生成した後、そのクラスを使ってカスタマイズできる内容を中心にご紹介します。<br /><br />
メイン処理クラスを生成するコマンドは以下の通り。<br />
<pre color-change="command" aria-label="コマンド実行（MainForTestというクラス名を指定する場合）">
> php worker craft:main MainForTest
[success] メイン処理クラスの生成に成功しました (MainForTest)
</pre><br />
生成されたクラスは<code>app/MainClass</code>の場所に<code>MainForTest.php</code>というファイル名で格納されます。<br />
新しいメイン処理クラスが増えるとUsageの<code>main</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 />
上記Usageのように<code>main</code>カテゴリに<code>app:main-for-test</code>という名前で追加されているのが確認できます。<br />
</div><br />
<a id="identifier"></a>
<h2 class="subtitle">サーバー識別子</h2>
<div class="text-block">
メイン処理クラスが生成されると以下のプロパティが確認できます。<br />
<pre color-change="php" aria-label="プロパティのメンバ">
/**
* @var string $identifer サーバー識別子
*/
protected string $identifer = 'app:main-for-test {port_no?}';
</pre><br />
ここではコマンドラインフォーマットを定義しています。<br />
<code>app:main-for-test</code>の部分がサーバーアプリケーション（プロセス）名で、<code>{port_no?}</code>の部分がコマンドパラメータ名であり、デフォルトで定義される内容です。<br />
そしてサーバーアプリケーション名や、コマンドパラメータは自由にカスタマイズできます。<br /><br />
例えばコマンドパラメータにホスト名を追加したい場合は以下のようにします。<br />
<pre color-change="php" aria-label="ホスト名のパラメータを追加">
/**
* @var string $identifer サーバー識別子
*/
protected string $identifer = 'app:main-for-test <font class="pre-yellow">{host_name}</font> {port_no?}';
</pre><br />
<code>port_no</code>の後ろに付いている"はてな（?）マーク"は省略可能である事を表しています。<br />
ちなみに"はてな（?）マーク"は最後尾の連続したパラメータにしか指定できません。<br />
例えば<code>{host_name?} {port_no?}</code>と書く事はできますが<code>{host_name?} {port_no}</code>と書く事はできません。<br /><br />
なお、メイン処理クラス内では<code>$this->getParameter('port_no')</code>のように書く事でパラメータを取得できます。<br />
省略可能なパラメータが省略されている時はnullが返却されます。<br />
</div><br />
<a id="description"></a>
<h2 class="subtitle">コマンド説明文</h2>
<div class="text-block">
メイン処理クラスが生成されると以下のプロパティが確認できます。<br />
<pre color-change="php" aria-label="プロパティのメンバ">
/**
* @var string $description コマンド説明
*/
protected string $description = 'Command description';
</pre><br />
ここではUsageを表示した時のサーバーコマンドの説明文を定義しています。<br />
初期状態では<code>Command description</code>となっているので、これをプロパティで変更できます。<br />
例えば以下のように変更すると<br />
<pre color-change="php" aria-label="説明文の変更">
/**
* @var string $description コマンド説明
*/
protected string $description = 'テスト用のサーバー';
</pre><br />
Usageでは以下のように表示されます。<br />
<pre color-change="command" aria-label="Usageの表示">
> php worker
SOCKET-MANAGER Framework 1.X.X
Usage:
command [arguments]
main
app:main-for-test テスト用のサーバー
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 />
</div><br />
<a id="setting"></a>
<h2 class="subtitle">設定可能項目</h2>
<div class="text-block">
このメイン処理クラスであらかじめ設定可能な項目は、<code>SocketManager</code>クラスの引数とそのクラス内の<code>cycleDriven</code>メソッドの引数です。<br />
各引数の設定方法には以下の３種類があります。<br />
<dl>
<dt>①メイン処理クラス内で直接指定</dt>
<dd>この項目でご紹介する方法です。</dd>
<dt>②コマンドラインから取得</dt>
<dd>上記の<font><a href="./main.html#identifier">>> サーバー識別子</a></font>の項目でご紹介した方法です。</dd>
<dt>③設定ファイル</dt>
<dd><font><a href="./setting.html" target="_blank">▶設定ファイル</a></font>のページでご紹介している方法です。</dd>
</dl>
<br />
<h3 class="underline">SocketManagerクラスの引数</h3>
メイン処理クラスの実行（exec）メソッドの冒頭部分にはSocketManagerクラスのインスタンス生成部分である以下のコードが含まれています。<br />
<pre color-change="php" aria-label="実行処理の冒頭部分">
public function exec()
{
// 引数の取得
$port_no = $this->getParameter('port_no');
// ソケットマネージャーのインスタンス設定
$manager = new SocketManager('localhost', $port_no);
・
・
・
}
</pre><br />
このSocketManagerクラスの引数の内訳は次の通りです。<br />
<pre aria-label="SocketManagerクラスの引数">
１）ホスト名（デフォルト：127.0.0.1）
２）ポート番号（デフォルト：10000）
３）受信バッファサイズ（デフォルト：1024）
４）接続制限数（デフォルト：10）
</pre><br />
これら４つの項目をデフォルト値で指定すると以下のようになります。<br />
<pre color-change="php" aria-label="直接引数へ値を指定するパターン">
$manager = new SocketManager( '127.0.0.1', 10000, 1024, 10 );
</pre><br />
<pre color-change="php" aria-label="引数指定を省略する事によるデフォルト値の適用">
$manager = new SocketManager();
</pre><br />
<pre color-change="php" aria-label="null指定によるデフォルト値の適用">
$manager = new SocketManager( null, null, null, null );
</pre><br />
御覧の通り、直接値を指定する事もできますが、引数を省略したり、nullを指定する事で自動的にデフォルト値が適用される仕組みになっています。<br />
<br />
<h3 class="underline">cycleDrivenメソッドの引数</h3>
メイン処理クラスの実行（exec）メソッド末尾のソースにはノンブロッキングループ内で<code>cycleDriven</code>メソッドが呼ばれている箇所があります。<br />
<pre color-change="php" aria-label="実行処理の末尾部分">
public function exec()
{
・
・
・
// ノンブロッキングループ
while(true)
{
// 周期ドリブン
$ret = $manager->cycleDriven();
if($ret === false)
{
goto finish;
}
}
・
・
・
}
</pre><br />
この<code>cycleDriven</code>メソッドの引数の内訳は次の通りです。<br />
<pre aria-label="cycleDrivenメソッドの引数">
１）周期インターバルタイム（デフォルト：2000μs）
２）アライブチェックインターバルタイム（デフォルト：指定なし＝0s）
</pre><br />
これら２つの項目をデフォルト値で指定すると以下のようになります。<br />
<pre color-change="php" aria-label="直接引数へ値を指定するパターン">
$manager->cycleDriven( 2000, 0 );
</pre><br />
<pre color-change="php" aria-label="引数指定を省略する事によるデフォルト値の適用">
$manager->cycleDriven();
</pre><br />
御覧の通り、直接値を指定する事もできますが、引数を省略しても自動的にデフォルト値が適用される仕組みになっています。<br />
なお、ここではSocketManagerクラスの引数のようにnullを指定する事はできません。<br /><br />
このアライブチェックインターバルタイムはプロトコル部の<code>ALIVE</code>キューと連動していて、無通信状態のタイムアウト値として機能します。<br />
タイムアウト時のアクションは２段構えになっていて、一回目のタイムアウト時に<code>ALIVE</code>キューに切り替わると同時に一度リセットされ、サーバーからのポーリングに対する応答を受信してUNITがnlllを返すまでの間にタイムアウトが発生すると切断処理が実行されます。<br />
</div><br />
<a id="class"></a>
<h2 class="subtitle">クラス適用項目</h2>
<div class="text-block">
メイン処理クラスの実行（exec）メソッドの中ほどに以下のコメント部分があります。<br />
<pre color-change="php" aria-label="実行処理の中腹部分">
public function exec()
{
・
・
・
/**
* 初期化クラスの設定
*
* $manager->setInitSocketManager()メソッドで初期化クラスを設定します
*/
/**
* プロトコルUNITの設定
*
* $manager->setProtocolUnits()メソッドでプロトコルUNITクラスを設定します
*/
/**
* コマンドUNITの設定
*
* $manager->setCommandUnits()メソッドでコマンドUNITクラスを設定します
*/
・
・
・
}
</pre><br />
あらかじめ作成しておいた初期化クラス／プロトコルUNITクラス／コマンドUNITクラスのインスタンスは、ここで以下のように引き渡してフレームワークライブラリへ適用します。
<pre color-change="php" aria-label="各クラスの適用">
public function exec()
{
・
・
・
/**
* 初期化クラスの設定
*/
$manager->setInitSocketManager(new InitForTest());
/**
* プロトコルUNITの設定
*/
$manager->setProtocolUnits(new ProtocolForTest());
/**
* コマンドUNITの設定
*/
$manager->setCommandUnits(new CommandForTest());
・
・
・
}
</pre><br />
あらかじめ複数のプロトコルUNITクラスやコマンドUNITクラスを用意している場合は、この部分を組み替える事によってプロトコルを組み替えたりサーバーコンテンツを組み替えたりする事が可能になります。<br />
</div><br />
<a id="ipc"></a>
<h2 class="subtitle">サーバー間通信の構成</h2>
<div class="text-block">
サーバー間通信（IPC）を実装する時、一般にサーバーのビジネスロジック部分に組み込む事が多く、その場合、クライアント通信で使っているプロトコル処理とサーバー間通信で使っているプロトコル処理が混ざってしまって煩雑になりがちです。<br />
そこで、本フレームワーク環境ではメイン処理クラスの構成を工夫する事でこれを回避できるようにしています。<br /><br />
まずはこれまでの手順を踏まえると、メイン処理クラスのシーケンスは以下の４つの構成に分ける事ができます。<br /><br />
<dl>
<dt>①SocketManagerクラスのインスタンス生成</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager = new SocketManager(<ホスト名>, <ポート番号>);
</pre><br /><br />
</dd>
<dt>②各クラス（初期化クラス／プロトコルUNITクラス／コマンドUNITクラス）のSocketManagerインスタンスへの適用</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager->setInitSocketManager(new InitForTest());
$manager->setProtocolUnits(new ProtocolForTest());
$manager->setCommandUnits(new CommandForTest());
</pre><br /><br />
</dd>
<dt>③ソケットをリッスン</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager->listen();
</pre><br /><br />
</dd>
<dt>④ノンブロッキングループでSocketManagerクラスのcycleDrivenメソッドを実行</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager->cycleDriven();
</pre><br />
</dd>
</dl>
基本的な構成は１エントリポイントに対して<code>１SocketManager＝１待ち受けポート</code>になりますが、仮にこれを複数のサーバープロセスで運用し、サーバー間通信によってブロードキャストする仕組みにする場合、以下のように１エントリポイントに対して<code>２SocketManager＝２待ち受けポート</code>の構成にする事でサーバー間通信を可能とするマルチサーバー構成を組み立てる事ができます。<br /><br />
<dl>
<dt>①SocketManagerクラスのインスタンス生成</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager_client = new SocketManager(<ホスト名>, <ポート番号1>); // クライアント通信用
$manager_server = new SocketManager(<ホスト名>, <ポート番号2>); // サーバー間通信用
</pre>
※TCP通信の場合、クライアント通信用とサーバー間通信用とでポートを分ける必要があります。<br /><br /><br />
</dd>
<dt>②各クラス（初期化クラス／プロトコルUNITクラス／コマンドUNITクラス）のSocketManagerインスタンスへの適用</dt>
<dd>
<pre color-change="php" aria-label="実装例">
// グローバル共有の設定
$param_client = new ParameterForClient();
$param_server = new ParameterForServer();
$param_client->setServerResource($param_server);
$param_server->setClientResource($param_client);
// クライアント通信用
$manager_client->setInitSocketManager(new InitForClient($param_client));
$manager_client->setProtocolUnits(new ProtocolForClient());
$manager_client->setCommandUnits(new CommandForClient());
// サーバー間通信用
$manager_server->setInitSocketManager(new InitForServer($param_server));
$manager_server->setProtocolUnits(new ProtocolForServer());
$manager_server->setCommandUnits(new CommandForServer());
</pre>
クライアント通信用とサーバー間通信用とでリソースの共有ができるように、あらかじめUNITパラメータクラスのインスタンスをグローバル共有として交換設定しています。<br /><br /><br />
</dd>
<dt>③ソケットをリッスン</dt>
<dd>
<pre color-change="php" aria-label="実装例（TCP通信用）">
$manager_client->listen(); // クライアント通信用
$manager_server->listen(); // サーバー間通信用
$manager_server->connect(<ホスト名>, <ポート番号>); // サーバー間通信用
・
・
・
</pre>
<pre color-change="php" aria-label="実装例（UDP通信用）">
$manager_client->listen(); // クライアント通信用
$manager_server->bind(); // サーバー間通信用
$manager_server->connect(<ホスト名>, <ポート番号>, true);// サーバー間通信用
・
・
・
</pre>
サーバー間通信用は、自身を除くサーバープロセス分のコネクションを張っておく必要があります。<br /><br /><br />
</dd>
<dt>④ノンブロッキングループでSocketManagerクラスのcycleDrivenメソッドを実行</dt>
<dd>
<pre color-change="php" aria-label="実装例">
$manager_client->cycleDriven(); // クライアント通信用
$manager_server->cycleDriven(); // サーバー間通信用
</pre><br />
</dd>
</dl>
このように、SocketManagerクラスをクライアント通信用とサーバー間通信用とに分ける事でそれぞれの管理を完全に分離する事ができます。<br />
例えばクライアント接続用としてWebsocketプロトコルの実装を１つのSocketManagerクラスに割り当て、サーバー間通信用としてオリジナルプロトコル（TCP/UDP）の実装を別のSocketManagerクラスに割り当てる事で、どちらもフレームワーク上のコマンドやアーキテクチャを同じように使って実装できるようになります。<br /><br />
この関係を図にすると以下の関係が成り立ちます。<br /><br />
<a href="./img/index/diagram.png" target="_blank"><img src="./img/index/diagram.png" width="500px" loading="lazy" alt="1プロセス内で複数のプロトコル（例：TCP／UDP）と異なるビジネスロジックを共存させた代表的な構成例" /></a><br /><br />
仮に、クライアント通信を経てサーバー間通信を行う際は、コンテキストを経由してサーバー間通信用のインスタンスから<code>setSendStackAll</code>メソッドを呼び出す事でブロードキャストできます。<br />
逆に、サーバー間通信を経て受信したデータをクライアント通信側へ引き渡す際は、コンテキストを経由してクライアント通信用のインスタンスから<code>setSendStack</code>メソッドを呼び出す事で該当するクライアントに対して送信する事ができます。<br /><br />
このような構成にする事でアーキテクチャレベルでのINETソケットを利用したサーバー間通信が可能になり、例えばIPC／メッセージング／共有メモリなどの機能を担うライブラリやサーバーを必要としないため、バージョン管理やサーバー設置・運用などで発生する手間やコストを省く事に貢献できるようになります。<br /><br />
また、ホスト名やポート番号を設定ファイルで管理できるようにするか、あるいは<code>getParameter</code>メソッドを使ってコマンドパラメータから引き渡せるようにしておくと、同じメイン処理クラスを使って複数のサーバープロセスを起ち上げる事ができるようになります。<br />
</div><br />
<a id="last"></a>
<h2 class="subtitle">おわりに</h2>
<div class="text-block">
これまで見てきたように、メイン処理クラスではコマンドライン／設定項目／プロトコル／サーバーコンテンツの組み合わせを自由にデザインすることができます。<br /><br />
今回一例としてご紹介したブロードキャストタイプのサーバー間通信構成は、通信データを一方的に相手に送り付けるだけのものでしたが、場合によっては親サーバー側で全てをコントロールできる親子関係の構成にして、通信トラフィックを抑えながら双方向通信でやり取りできるようにした方がいい場合もあります。<br />
<font><a href="./multi-server.html" target="_blank">▶マルチサーバーの構成</a></font>のページでは親子関係のマルチサーバー構成を図解付きで詳しくご紹介していますので合わせてご覧ください。<br /><br />
<font><a href="./index.html" target="_blank">▶フレームワークのご紹介</a></font>のページでご紹介しているデモ環境では、プライベートメッセージのサーバー間通信を親子関係で構築している実装例を組み込んでいます。<br />
以下のUsageのうち「TCPマルチ」と表示されているコマンドがTCPソケットを使ってサーバー間通信を行うマルチサーバーで、「UDPマルチ」と表示されているコマンドがUDPソケットを使ってサーバー間通信を行うマルチサーバーの実装です。<br />
<pre color-change="command" aria-label="デモ環境のUsage">
SOCKET-MANAGER Framework 1.X.X
Usage:
command [arguments]
main
app:minecraft-chat-server マインクラフト版チャットサーバー
app:tcpmulti-server TCPマルチチャットサーバー
app:tcpmulti-minecraft-server TCPマルチマインクラフト版チャットサーバー
app:udpmulti-server UDPマルチチャットサーバー
app:udpmulti-minecraft-server UDPマルチマインクラフト版チャットサーバー
app:chat-server チャットサーバー
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 />
</div>
</div>
</div>
</body>
</html>