-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforge-sockets.html
More file actions
864 lines (840 loc) · 45.8 KB
/
Copy pathforge-sockets.html
File metadata and controls
864 lines (840 loc) · 45.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
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
<!doctype html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Forge Kernel - ForgeSockets</title>
<script src="https://cdn.tailwindcss.com"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
rel="stylesheet"
/>
<link rel="stylesheet" href="assets/css/docs.css" />
</head>
<body class="bg-gray-50 text-gray-900">
<!-- Navigation -->
<nav class="bg-white shadow-sm border-b">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex items-center">
<div class="flex-shrink-0">
<h1 class="text-xl font-bold text-gray-900">
Forge Kernel
</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a
href="index.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Home
</a>
<a
href="getting-started.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Getting Started
</a>
<a
href="core-concepts.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Core Concepts
</a>
<a
href="capabilities.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Capabilities
</a>
<a
href="api-reference.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
API Reference
</a>
<a
href="tutorial.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Tutorials
</a>
</div>
</div>
<div class="flex items-center sm:hidden">
<button
id="mobile-menu-button"
class="text-gray-700 hover:text-blue-600 p-2"
>
<i class="fas fa-bars text-xl"></i>
</button>
</div>
</div>
</div>
<div
id="mobile-menu"
class="sm:hidden hidden bg-white border-t border-gray-200"
>
<div class="px-2 pt-2 pb-3 space-y-1">
<a
href="index.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Home</a
>
<a
href="getting-started.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Getting Started</a
>
<a
href="core-concepts.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Core Concepts</a
>
<a
href="capabilities.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Capabilities</a
>
<a
href="api-reference.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>API Reference</a
>
<a
href="tutorial.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Tutorials</a
>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<div class="flex flex-col lg:flex-row gap-8">
<!-- Sidebar Navigation -->
<div id="sidebar-nav" class="lg:w-1/4">
<div class="bg-white rounded-lg shadow-sm p-6 sticky top-8">
<h3 class="text-lg font-semibold text-gray-900 mb-4">
ForgeSockets
</h3>
<nav class="space-y-2">
<a
href="#overview"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Overview</a
>
<a
href="#primitives-not-a-platform"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Primitives, Not a Platform</a
>
<a
href="#installation"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Installation</a
>
<a
href="#running-the-worker"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Running the Worker</a
>
<a
href="#your-message-handler"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Your Message Handler</a
>
<a
href="#the-connection"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>The Connection</a
>
<a
href="#game-clocks"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Game Clocks & Ticks</a
>
<a
href="#authenticating"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Authenticating</a
>
<a
href="#the-protocol"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>The Protocol</a
>
<a
href="#configuration"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Configuration</a
>
</nav>
<div class="mt-6 pt-6 border-t border-gray-200">
<h4 class="font-semibold text-sm mb-3 text-blue-600">
Related
</h4>
<nav class="space-y-2">
<a
href="forge-wire.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeWire — reactive controller rendering→</a
>
<a
href="forge-htmx.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeHtmx — HTMX integration →</a
>
<a
href="forge-sprinkle.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeSprinkle — browser-side enhancements→</a
>
<a
href="capabilities.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>All capabilities →</a
>
</nav>
</div>
</div>
</div>
<!-- Main Content -->
<div class="lg:w-3/4">
<div class="bg-white rounded-lg shadow-sm p-8">
<h1 class="text-4xl font-bold text-gray-900 mb-6">
ForgeSockets
</h1>
<p class="text-xl text-gray-600 mb-4">
Zero-dependency WebSocket primitives that <strong>your
app</strong> can run as a long-lived worker — opening
handshake, frame encoding and parsing, and a
non-blocking event loop, all in pure PHP. Plug in a
message handler and a stream of realtime connections
is yours; there is no framework owning the page, just
a transport your code reacts to.
</p>
<!-- Overview -->
<section id="overview" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Overview
</h2>
<p class="text-gray-600 mb-4">
ForgeSockets implements RFC 6455 — the WebSocket
protocol — on top of PHP's built-in networking
(no extensions, no external libraries). It ships
as two halves:
</p>
<div class="grid md:grid-cols-2 gap-4 mb-6">
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">
The primitives
</h3>
<p class="text-sm text-gray-700">
The <code>Handshake</code>, frame
<code>Parser</code>/<code>Codec</code>,
and <code>EventLoop</code> classes that
speak RFC 6455 for you. Handlers and
authenticators are injected, so the
primitive knows nothing about rooms,
games, or users — <em>your</em> app does.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">
The worker
</h3>
<p class="text-sm text-gray-700">
A single long-running CLI process —
<code>modules:socket:serve</code> — that
binds a port, accepts connections, and
pumps the event loop until asked to stop.
The same process model as the Forge queue
worker (pcntl signals, graceful drain).
</p>
</div>
</div>
<p class="text-gray-600">
The transport handles the hard, repetitive parts
of the protocol — the opening handshake, masked
frame parsing, control frames, heartbeat, and the
closing handshake — so the code you write is only
about <em>what your app does</em> with each
connection and message.
</p>
</section>
<!-- Primitives, Not a Platform -->
<section
id="primitives-not-a-platform"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Primitives, Not a Platform
</h2>
<p class="text-gray-600 mb-4">
ForgeSockets is deliberately not a turnkey
realtime platform. It does not ship chat rooms,
presence, channels, or pub/sub — because those are
<em>app</em> concerns that depend on your domain.
What it gives you is the transport, so you decide
the semantics:
</p>
<ul class="space-y-2 list-disc list-inside text-gray-700 mb-4">
<li>
A message handler receives every completed
frame — text or binary — and decides what it
means for your app.
</li>
<li>
The request <em>path</em> from the handshake
(for example <code>/ws/arcades/the-hall</code>)
is exposed, so you can route a connection to
whatever room, game, or channel <em>you</em>
model.
</li>
<li>
Handling is single-process and
single-threaded by default. You scale by
adding worker processes, and your own logic
decides how multiple workers coordinate.
</li>
</ul>
<div
class="bg-blue-50 border border-blue-200 rounded-lg p-6"
>
<p class="text-sm text-gray-700">
A common pattern: a turn-based game hub or a
chat/notifications hub is not something the
kernel ships. It's code in <em>your app</em> —
a <code>MessageHandlerInterface</code> that
knows your data — running on top of this
transport. Combine it with ForgeSprinkle or
ForgeWire on the browser side and you've
assembled a realtime app without a realtime
framework.
</p>
</div>
</section>
<!-- Installation -->
<section
id="installation"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Installation
</h2>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-bash">php forge.php package:install-module --module=ForgeSockets</code></pre>
</div>
<p class="text-gray-600 mb-4">
The capability has no web-facing UI, routes, or
middleware — it's a CLI worker plus the protocol
classes. Everything you wire up happens in your
own handler and authenticator classes, and in the
<code>forge_sockets.*</code> config:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">forge_sockets:
host: 127.0.0.1,
port: 8282,
max_payload: 65536,
heartbeat_seconds: 30,
workers: 1,
handler: Modules\MyApp\Handlers\MyHandler,
authenticator: null,</code></pre>
</div>
<p class="text-gray-600">
The default handler is a simple echo that proves
the transport end-to-end before you plug in your
real one.
</p>
</section>
<!-- Running the Worker -->
<section
id="running-the-worker"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Running the Worker
</h2>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-bash">php forge.php modules:socket:serve</code></pre>
</div>
<p class="text-gray-600 mb-4">
Binds the configured host and port and runs the
event loop until it receives <code>SIGINT</code>
or <code>SIGTERM</code>, at which point it drains
every open connection (sending close code 1001,
<em>going away</em>) and exits cleanly. Options:
</p>
<ul class="space-y-2 list-disc list-inside text-gray-700 mb-4">
<li>
<code>--host=HOST</code> /
<code>--port=PORT</code> — override the bind
address (defaults to config).
</li>
<li>
<code>--handler=CLASS</code> —
<code>MessageHandlerInterface</code> to use
(config default).
</li>
<li>
<code>--authenticator=CLASS</code> — an
<code>AuthenticatorInterface</code> to gate
connections (config default).
</li>
</ul>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-6"
>
<p class="text-sm text-gray-700">
You'd typically run this under a process
supervisor (systemd, a container, or Forge's
own tooling) so it restarts on crash and
scales to as many <code>workers</code> as your
app needs.
</p>
</div>
</section>
<!-- Your Message Handler -->
<section
id="your-message-handler"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Your Message Handler
</h2>
<p class="text-gray-600 mb-4">
Implementing <code>MessageHandlerInterface</code>
is the whole job of the application side. The
transport handles handshake, framing, heartbeat,
and close — your code reacts to the four lifecycle
events:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Modules\ForgeSockets\Contracts\ConnectionInterface;
use Modules\ForgeSockets\Contracts\MessageHandlerInterface;
use Modules\ForgeSockets\Server\Frames\Opcode;
final class MyHandler implements MessageHandlerInterface
{
public function onOpen(ConnectionInterface $c): void
{
// handshake done and (if configured) authenticated
$c->sendText('{"event":"welcome","id":' . $c->id() . '}');
}
public function onMessage(ConnectionInterface $c, Opcode $opcode, string $payload): void
{
// only complete data frames arrive here; control frames are auto-handled
$c->sendText('you said: ' . $payload);
}
public function onClose(ConnectionInterface $c, int $code, string $reason): void
{
// socket fully torn down; 1000 normal, 1001 going away, 1006 abnormal...
}
public function onError(ConnectionInterface $c, \Throwable $error): void
{
// a frame parse or handler error on this connection
}
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Register it as the handler in your config, or pass
it on the command line, and it becomes the heart
of your realtime feature. Because the handler is
resolved through the container, it can receive
your own services (repositories, the event bus,
your domain logic) via its constructor.
</p>
<p class="text-gray-600">
Note the contract: the transport answers ping,
pong, and the closing handshake for you, so
<code>onMessage</code> only ever sees
<em>data</em> frames (text or binary), and it only
ever receives <em>complete</em> messages — the
parser reassembles fragmented frames before they
reach you.
</p>
</section>
<!-- The Connection -->
<section
id="the-connection"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
The Connection
</h2>
<p class="text-gray-600 mb-4">
Handlers interact with a
<code>ConnectionInterface</code> — a narrow,
safe view of one live socket. It can send and
close; the transport owns buffering, backpressure,
control frames, and the actual socket:
</p>
<ul class="space-y-2 list-disc list-inside text-gray-700 mb-4">
<li>
<code>id()</code> — a stable per-process
connection id.
</li>
<li>
<code>peer()</code> — the remote
<code>host:port</code>.
</li>
<li>
<code>path()</code> — the handshake request
path, for routing to the right room/feature.
</li>
<li>
<code>user()</code> — the opaque user id
resolved by your authenticator at handshake,
or <code>null</code> without one.
</li>
<li>
<code>sendText(string)</code> /
<code>sendBinary(string)</code> — queue UTF-8
text or binary to the client.
</li>
<li>
<code>close(int $code = 1000, string
$reason = '')</code> — begin the closing
handshake; no more data after.
</li>
</ul>
<p class="text-gray-600">
To push a message to many clients, keep the
connections you care about — by room, by user, by
game — in a structure that makes sense for your app
and call <code>sendText</code> on each. That lookup
and routing is domain logic, so it lives in your
handler, not the transport.
</p>
</section>
<!-- Game Clocks & Ticks -->
<section
id="game-clocks"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Game Clocks & Ticks
</h2>
<p class="text-gray-600 mb-4">
For turn-based and realtime simulations, you can
opt into a periodic heartbeat for your own logic by
implementing <code>TickableHandler</code>. When a
handler does, the server calls
<code>onTick(float $now)</code> on a cadence —
good for game clocks, turn timeouts, and scheduled
advancement:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Modules\ForgeSockets\Contracts\TickableHandler;
final class GameLoop implements MessageHandlerInterface, TickableHandler
{
public function onTick(float $now): void
{
// advance turns, expire timeouts, broadcast state to your rooms
}
}</code></pre>
</div>
<p class="text-gray-600">
The server only calls <code>onTick</code> when the
handler implements the interface, and the cadence
is configurable — the default suits turn-based
games, while a realtime hub can lower it to drive
its simulation scheduler faster. The
<em>event loop</em> tick stays independent of the
transport heartbeat, which is purely about keeping
stale sockets alive.
</p>
</section>
<!-- Authenticating -->
<section
id="authenticating"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Authenticating
</h2>
<p class="text-gray-600 mb-4">
WebSocket upgrades carry the browser's cookie
header, which means you can authenticate the
connection against your existing session —
the same sessions your HTTP routes use. An
<code>AuthenticatorInterface</code> resolves the
user behind a handshake:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Modules\ForgeSockets\Contracts\AuthenticatorInterface;
final class SessionAuthenticator implements AuthenticatorInterface
{
public function authenticate(string $path, array $headers): ?string
{
$cookie = $headers['cookie'] ?? '';
// read your session id from the cookie and look up the user...
return $userId; // open the connection as this user
// return null; // reject the connection (closed with 1008)
}
}</code></pre>
</div>
<p class="text-gray-600">
Returning a string opens the connection with
<code>$connection->user()</code> set to that id;
returning <code>null</code> rejects it (the
handshake responds 403 and the connection closes
with 1008, <em>policy violation</em>). It receives
both the request path and the raw headers, so you
can resolve the user from your session driver and
route by path in one place.
</p>
</section>
<!-- The Protocol -->
<section
id="the-protocol"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
The Protocol
</h2>
<p class="text-gray-600 mb-4">
Under the hood, ForgeSockets is a faithful RFC 6455
implementation. It's worth knowing what's handled
so you can rely on it:
</p>
<div class="space-y-4 text-sm text-gray-700 mb-6">
<div>
<h3 class="font-semibold text-base mb-1">
Opening handshake
</h3>
<p>
A <code>GET ... HTTP/1.1</code> upgrade is
validated (version 13, correct
<code>Upgrade</code>/<code>Connection</code>
headers, a well-formed
<code>Sec-WebSocket-Key</code>) and
answered with <code>101 Switching
Protocols</code> carrying the
<code>Sec-WebSocket-Accept</code> key
computed per the spec.
</p>
</div>
<div>
<h3 class="font-semibold text-base mb-1">
Framing
</h3>
<p>
Server frames are parsed incrementally —
handling multiple frames per packet,
frames split across packets, and
fragmented messages reassembled into one
complete frame. Client frames must be
masked (an unmasked frame is a protocol
error, 1002). Text frames are validated as
UTF-8 (1007 on failure); reserved opcodes
and RSV bits are rejected (1002).
</p>
</div>
<div>
<h3 class="font-semibold text-base mb-1">
Control frames
</h3>
<p>
Ping is answered with a pong automatically;
close begins the closing handshake. Control
frames are processed immediately even when
interleaved inside a fragmented message.
</p>
</div>
<div>
<h3 class="font-semibold text-base mb-1">
Heartbeat & limits
</h3>
<p>
Every <code>heartbeat_seconds</code>, the
server pings connections idle past the
interval and aborts ones idle past twice
it. Frames over <code>max_payload</code>
(1009) and an overflowing send queue (a
slow client, 1008) close the connection.
</p>
</div>
<div>
<h3 class="font-semibold text-base mb-1">
Close codes
</h3>
<p>
1000 normal, 1001 going away (server
shutdown), 1002 protocol error, 1006
abnormal/EOF, 1007 invalid payload, 1008
policy violation, 1009 message too big,
1011 internal error. 1006 is reported to
the handler only — it's never sent on the
wire.
</p>
</div>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-6"
>
<p class="text-sm text-gray-700">
The event loop is built on
<code>stream_select</code>, present in every
PHP build. Read interest stays steady per
connection; write interest is toggled on only
when a connection has queued bytes
(backpressure-driven), so the loop never does
wasted work and heartbeats and game ticks
always fire on schedule.
</p>
</div>
</section>
<!-- Configuration -->
<section
id="configuration"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Configuration
</h2>
<p class="text-gray-600 mb-6">
All settings are read from config or environment
variables (<code>env()</code> wins over config
defaults):
</p>
<div
class="overflow-x-auto bg-gray-50 border border-gray-200 rounded-lg"
>
<table class="w-full text-sm text-left text-gray-700">
<thead class="bg-gray-200">
<tr>
<th class="px-4 py-2">Config</th>
<th class="px-4 py-2">Env</th>
<th class="px-4 py-2">Default</th>
<th class="px-4 py-2">Purpose</th>
</tr>
</thead>
<tbody class="divide-y divide-gray-200">
<tr>
<td class="px-4 py-2">host</td>
<td class="px-4 py-2">SOCKET_HOST</td>
<td class="px-4 py-2">127.0.0.1</td>
<td class="px-4 py-2">Bind address</td>
</tr>
<tr>
<td class="px-4 py-2">port</td>
<td class="px-4 py-2">SOCKET_PORT</td>
<td class="px-4 py-2">8282</td>
<td class="px-4 py-2">Bind port</td>
</tr>
<tr>
<td class="px-4 py-2">max_payload</td>
<td class="px-4 py-2">SOCKET_MAX_PAYLOAD</td>
<td class="px-4 py-2">65536</td>
<td class="px-4 py-2">Max frame/message bytes (1009)</td>
</tr>
<tr>
<td class="px-4 py-2">heartbeat_seconds</td>
<td class="px-4 py-2">SOCKET_HEARTBEAT</td>
<td class="px-4 py-2">30</td>
<td class="px-4 py-2">Ping cadence; abort at 2x</td>
</tr>
<tr>
<td class="px-4 py-2">workers</td>
<td class="px-4 py-2">SOCKET_WORKERS</td>
<td class="px-4 py-2">1</td>
<td class="px-4 py-2">Worker process count</td>
</tr>
<tr>
<td class="px-4 py-2">handler</td>
<td class="px-4 py-2">—</td>
<td class="px-4 py-2">EchoHandler</td>
<td class="px-4 py-2">Your MessageHandlerInterface</td>
</tr>
<tr>
<td class="px-4 py-2">authenticator</td>
<td class="px-4 py-2">—</td>
<td class="px-4 py-2">null</td>
<td class="px-4 py-2">Your AuthenticatorInterface</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="bg-gray-900 text-white py-8 mt-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<div class="mb-4">
<span class="text-lg font-bold">Forge Kernel</span>
</div>
<p class="text-gray-400">
A toolbox for builders who like to do things their way.
</p>
</div>
</footer>
<script>
document.querySelectorAll('a[href^="#"]').forEach((anchor) => {
anchor.addEventListener("click", function (e) {
e.preventDefault();
const target = document.querySelector(
this.getAttribute("href"),
);
if (target) {
target.scrollIntoView({
behavior: "smooth",
block: "start",
});
}
});
});
const mobileMenuButton =
document.getElementById("mobile-menu-button");
const mobileMenu = document.getElementById("mobile-menu");
if (mobileMenuButton && mobileMenu) {
mobileMenuButton.addEventListener("click", function () {
mobileMenu.classList.toggle("hidden");
});
}
window.addEventListener("scroll", function () {
const sections = document.querySelectorAll(".section-anchor");
const navLinks = document.querySelectorAll(".nav-link");
let current = "";
sections.forEach((section) => {
const sectionTop = section.offsetTop - 100;
if (window.pageYOffset >= sectionTop) {
current = section.getAttribute("id");
}
});
navLinks.forEach((link) => {
link.classList.remove("active");
if (link.getAttribute("href") === "#" + current) {
link.classList.add("active");
}
});
});
</script>
</body>
</html>