-
-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathindex.html
More file actions
1886 lines (1804 loc) · 193 KB
/
index.html
File metadata and controls
1886 lines (1804 loc) · 193 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="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>Socket - ReactPHP</title>
<meta name="description" content="Async, streaming plaintext TCP/IP and secure TLS socket server and client connections for ReactPHP.">
<link rel="apple-touch-icon" sizes="180x180" href="https://reactphp.org/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="https://reactphp.org/favicon-32x32.png">
<link rel="manifest" href="https://reactphp.org/manifest.json">
<link rel="mask-icon" href="https://reactphp.org/safari-pinned-tab.svg" color="#4f5b93">
<meta name="apple-mobile-web-app-title" content="ReactPHP">
<meta name="application-name" content="ReactPHP">
<meta name="theme-color" content="#f4f3f1">
<meta name="msapplication-config" content="https://reactphp.org/browserconfig.xml" />
<meta property="og:image" content="https://reactphp.org/og-image.png">
<link rel="preload" href="../assets/sourcesanspro-regular.f84b2bd4.woff" as="font" type="font/woff" crossorigin>
<link rel="preload" href="../assets/sourcesanspro-bold.cb7d3610.woff" as="font" type="font/woff" crossorigin>
<script>window.__assets = '../assets/';</script>
<script>!function(){"use strict";var e,t,n,r,o,i={},u={};function a(e){var t=u[e];if(void 0!==t)return t.exports;var n=u[e]={exports:{}};return i[e].call(n.exports,n,n.exports,a),n.exports}a.m=i,e=[],a.O=function(t,n,r,o){if(!n){var i=1/0;for(l=0;l<e.length;l++){n=e[l][0],r=e[l][1],o=e[l][2];for(var u=!0,f=0;f<n.length;f++)(!1&o||i>=o)&&Object.keys(a.O).every((function(e){return a.O[e](n[f])}))?n.splice(f--,1):(u=!1,o<i&&(i=o));if(u){e.splice(l--,1);var c=r();void 0!==c&&(t=c)}}return t}o=o||0;for(var l=e.length;l>0&&e[l-1][2]>o;l--)e[l]=e[l-1];e[l]=[n,r,o]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},a.d=function(e,t){for(var n in t)a.o(t,n)&&!a.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,n){return a.f[n](e,t),t}),[]))},a.u=function(e){return e+"."+{67:"ab055693",139:"820be3d5",261:"bd162b4a",553:"da065a6b"}[e]+".js"},a.miniCssF=function(e){return e+"."+{67:"4ae9feba",139:"3ced3f7b",553:"90d4e0e8"}[e]+".css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},t={},n="reactphp-website:",a.l=function(e,r,o,i){if(t[e])t[e].push(r);else{var u,f;if(void 0!==o)for(var c=document.getElementsByTagName("script"),l=0;l<c.length;l++){var s=c[l];if(s.getAttribute("src")==e||s.getAttribute("data-webpack")==n+o){u=s;break}}u||(f=!0,(u=document.createElement("script")).charset="utf-8",u.timeout=120,a.nc&&u.setAttribute("nonce",a.nc),u.setAttribute("data-webpack",n+o),u.src=e),t[e]=[r];var d=function(n,r){u.onerror=u.onload=null,clearTimeout(p);var o=t[e];if(delete t[e],u.parentNode&&u.parentNode.removeChild(u),o&&o.forEach((function(e){return e(r)})),n)return n(r)},p=setTimeout(d.bind(null,void 0,{type:"timeout",target:u}),12e4);u.onerror=d.bind(null,u.onerror),u.onload=d.bind(null,u.onload),f&&document.head.appendChild(u)}},a.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},a.p="",r=function(e){return new Promise((function(t,n){var r=a.miniCssF(e),o=a.p+r;if(function(e,t){for(var n=document.getElementsByTagName("link"),r=0;r<n.length;r++){var o=(u=n[r]).getAttribute("data-href")||u.getAttribute("href");if("stylesheet"===u.rel&&(o===e||o===t))return u}var i=document.getElementsByTagName("style");for(r=0;r<i.length;r++){var u;if((o=(u=i[r]).getAttribute("data-href"))===e||o===t)return u}}(r,o))return t();!function(e,t,n,r){var o=document.createElement("link");o.rel="stylesheet",o.type="text/css",o.onerror=o.onload=function(i){if(o.onerror=o.onload=null,"load"===i.type)n();else{var u=i&&("load"===i.type?"missing":i.type),a=i&&i.target&&i.target.href||t,f=new Error("Loading CSS chunk "+e+" failed.\n("+a+")");f.code="CSS_CHUNK_LOAD_FAILED",f.type=u,f.request=a,o.parentNode.removeChild(o),r(f)}},o.href=t,document.head.appendChild(o)}(e,o,t,n)}))},o={666:0},a.f.miniCss=function(e,t){o[e]?t.push(o[e]):0!==o[e]&&{67:1,139:1,553:1}[e]&&t.push(o[e]=r(e).then((function(){o[e]=0}),(function(t){throw delete o[e],t})))},function(){var e={666:0};a.f.j=function(t,n){var r=a.o(e,t)?e[t]:void 0;if(0!==r)if(r)n.push(r[2]);else if(666!=t){var o=new Promise((function(n,o){r=e[t]=[n,o]}));n.push(r[2]=o);var i=a.p+a.u(t),u=new Error;a.l(i,(function(n){if(a.o(e,t)&&(0!==(r=e[t])&&(e[t]=void 0),r)){var o=n&&("load"===n.type?"missing":n.type),i=n&&n.target&&n.target.src;u.message="Loading chunk "+t+" failed.\n("+o+": "+i+")",u.name="ChunkLoadError",u.type=o,u.request=i,r[1](u)}}),"chunk-"+t,t)}else e[t]=0},a.O.j=function(t){return 0===e[t]};var t=function(t,n){var r,o,i=n[0],u=n[1],f=n[2],c=0;if(i.some((function(t){return 0!==e[t]}))){for(r in u)a.o(u,r)&&(a.m[r]=u[r]);if(f)var l=f(a)}for(t&&t(n);c<i.length;c++)o=i[c],a.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return a.O(l)},n=self.webpackChunkreactphp_website=self.webpackChunkreactphp_website||[];n.forEach(t.bind(null,0)),n.push=t.bind(null,n.push.bind(n))}()}();</script>
<style>@font-face{font-display:swap;font-family:Source Sans Pro;font-style:normal;font-weight:400;src:local("Source Sans Pro Regular"),local("SourceSansPro-Regular"),url(../assets/sourcesanspro-regular.f84b2bd4.woff) format("woff")}@font-face{font-display:swap;font-family:Source Sans Pro;font-style:normal;font-weight:700;src:local("Source Sans Pro Bold"),local("SourceSansPro-Bold"),url(../assets/sourcesanspro-bold.cb7d3610.woff) format("woff")}@font-face{font-family:icons;font-style:normal;font-weight:400;src:url(../assets/icons.f41c5641.ttf?ae19fi) format("truetype"),url(../assets/icons.cf61dfff.woff?ae19fi) format("woff"),url(../assets/icons.b4abbede.svg?ae19fi#icons) format("svg")}[class*=" icon-"],[class^=icon-]{speak:none;-webkit-font-feature-settings:normal;font-feature-settings:normal;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-family:icons!important;font-style:normal;font-variant:normal;font-weight:400;line-height:1;text-transform:none}.icon-hash:before{content:"\e900"}.icon-twitter:before{content:"\e901"}.icon-github:before{content:"\e902"}.icon-blog:before{content:"\e905"}.icon-earth:before{content:"\e903"}.icon-link:before{content:"\e906"}.icon-youtube:before{content:"\e904"}.icon-book:before{content:"\f007"}.icon-calendar:before{content:"\f068"}.icon-chevron-down:before{content:"\f0a3"}.icon-chevron-up:before{content:"\f0a2"}.icon-law:before{content:"\f0d8"}.icon-search:before{content:"\f02e"}.icon-x:before{content:"\f081"}.icon-feed:before{content:"\ea9b"}[class*=" icon-"],[class^=icon-]{vertical-align:-8%}html{-webkit-box-sizing:border-box;box-sizing:border-box;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol;font-size:16px;line-height:1.6}@media (max-width:768px){html{font-size:18px}}*,:after,:before{-webkit-box-sizing:inherit;box-sizing:inherit}body{background-color:#fff;color:#584b4f;color:var(--color-base);margin:0}a{color:#4f5b93;color:var(--color-key)}a:hover{color:#a2aacd;color:var(--color-key-light);text-decoration:underline}blockquote{background-color:#f4f3f1;background-color:var(--color-background-lighter);border-left:4px solid #4f5b93;border-left:4px solid var(--color-key);border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);font-size:.875rem;padding:16px 16px 16px 24px;position:relative}blockquote:before{background:#4f5b93;background:var(--color-key);border-radius:50%;-webkit-box-sizing:border-box;box-sizing:border-box;color:#fff;content:"i";display:block;font-size:12px;font-weight:700;height:24px;left:-14px;line-height:24px;padding:0 4px;position:absolute;text-align:center;top:12px;width:24px}blockquote :last-child{margin-bottom:0}blockquote,fieldset,form,h1,h2,h3,h4,h5,h6,hr,ol,p,ul{margin:0 0 16px}ul ul{margin-bottom:0}hr{border:0;border-bottom:1px dashed #eae8e3;border-bottom:1px dashed var(--color-background-light);clear:both;height:0;padding:0}h1,h2,h3,h4,h5,h6{-webkit-font-smoothing:antialiased;color:#584b4f;color:var(--color-base);font-family:Source Sans Pro,Helvetica Neue,Arial,sans-serif;font-weight:700;line-height:1}h1 a,h1 a:hover,h2 a,h2 a:hover,h3 a,h3 a:hover,h4 a,h4 a:hover,h5 a,h5 a:hover,h6 a,h6 a:hover{text-decoration:none}h1{font-size:2.5rem;letter-spacing:-1px;margin-bottom:32px}h1,h1 a,h1 a:hover{color:#4f5b93;color:var(--color-key)}h1:not(:first-child){margin-top:32px}h2{font-size:2rem;margin-bottom:32px}h2,h2 a,h2 a:hover{color:#4f5b93;color:var(--color-key)}h2:not(:first-child){margin-top:32px}h3{font-size:1.5rem;margin-bottom:24px}h3,h3 a,h3 a:hover{color:#584b4f;color:var(--color-base)}h3:not(:first-child){margin-top:24px}h4{font-size:1.25rem}h4,h4 a,h4 a:hover{color:#4f5b93;color:var(--color-key)}h4:not(:first-child){margin-top:24px}@media (max-width:768px){h1{font-size:2rem}h2{font-size:1.75rem;margin-bottom:32px}}.container{padding:32px}@media (max-width:768px){.container{padding:16px}}.wrapper{margin:auto;max-width:1600px}.wrapper--medium{max-width:1280px}.wrapper--small{margin:auto;max-width:960px}.wrapper--narrow{max-width:640px}.main{width:calc(98% - 400px)}.main,.sidebar{margin-bottom:32px}.sidebar{width:calc(400px - 2%)}@media (max-width:1024px){.main,.sidebar{margin-top:16px;width:auto}}.visually-hidden{clip:rect(1px,1px,1px,1px);height:1px;overflow:hidden;position:absolute!important;width:1px}.grid{-ms-flex-pack:center;display:-ms-flexbox;display:flex;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap;justify-content:center;margin-left:-2%;width:102%}.grid>*{margin-left:2%;max-width:100%}.grid--4cols>*{-ms-flex-preferred-size:23%;flex-basis:23%}.grid--3cols>*{-ms-flex-preferred-size:31.33%;flex-basis:31.33%}.grid--2cols>*{-ms-flex-preferred-size:48%;flex-basis:48%}@media (max-width:768px){.grid{-ms-flex-direction:column;flex-direction:column}.grid,.grid>*{margin-left:0;width:100%}.grid>*{-ms-flex:0 0 auto;flex:0 0 auto}}.center{text-align:center}.center h1,.center h2,.center h3,.center h4,.center h5,.center h6,.hamburger{display:inline-block}.hamburger{background-color:transparent;border:0;color:inherit;cursor:pointer;font:inherit;height:48px;margin:0;outline:none;overflow:visible;padding:14px 12px;text-transform:none}.hamburger__box{display:inline-block;height:16px;position:relative;width:24px}.hamburger__inner{display:block;margin-top:-2px;top:50%}.hamburger__inner,.hamburger__inner:after,.hamburger__inner:before{background-color:#584b4f;background-color:var(--color-base);border-radius:2px;height:3px;position:absolute;-webkit-transition-duration:.15s;-o-transition-duration:.15s;transition-duration:.15s;-webkit-transition-property:-webkit-transform;transition-property:-webkit-transform;-o-transition-property:transform;transition-property:transform;transition-property:transform,-webkit-transform;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease;width:24px}.hamburger__inner:after,.hamburger__inner:before{content:"";display:block}.hamburger__inner:before{top:-6px}.hamburger__inner:after{bottom:-6px}.header{background:#fefefe;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.08);box-shadow:0 1px 0 0 rgba(0,0,0,.08);-webkit-box-shadow:var(--box-shadow-lightest);box-shadow:var(--box-shadow-lightest);padding:0 32px;width:100%}@media (max-width:768px){.header{padding:0 16px}}.header__container{-ms-flex-align:center;-ms-flex-pack:justify;align-items:center;display:-ms-flexbox;display:flex;justify-content:space-between;position:relative;width:100%}.header__logo{display:block;line-height:1;padding:16px 0}.header__logo svg{display:block;height:18px;width:120px}.header__search{margin:0;position:absolute;right:48px;top:7px;z-index:799}.header__search input{width:400px}@media (max-width:768px){.header__search input{width:calc(100vw - 94px)}}.header__menu{position:absolute;right:-12px;top:0;z-index:800}.footer{background:#584b4f;background:var(--color-base);padding:32px;text-align:center;text-shadow:1px 1px 0 rgba(0,0,0,.125)}.footer .links a{color:#eae8e3;color:var(--color-background-light);text-decoration:none}.footer .links a:hover{color:#9ad8bb;color:var(--color-green-light);text-decoration:none}.iframe{height:0;overflow:hidden;padding-bottom:56.25%;position:relative;width:100%}.iframe iframe{height:100%;left:0;position:absolute;top:0;width:100%}.links{margin:0;padding:0}.links li{display:inline-block;margin:0 8px;text-decoration:none}.links li:first-child{margin-left:0}.links li:last-child{margin-right:0}.links a{display:block}.box,.links a,.links a:hover{text-decoration:none}.box{background:#f4f3f1;background:var(--color-background-lighter);border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);color:inherit;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;margin-bottom:24px;margin-top:0;overflow:auto;padding:24px;text-align:left;vertical-align:top}.box:hover{background:#eae8e3;background:var(--color-background-light);-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.15);box-shadow:0 1px 0 0 rgba(0,0,0,.15);-webkit-box-shadow:var(--box-shadow-light);box-shadow:var(--box-shadow-light);text-decoration:none}.box h1,.box h2,.box h3,.box h4,.box h5,.box h6,.box hr,.box ol,.box p,.box ul{margin-bottom:8px}.box h1,.box h2,.box h3,.box h4,.box h5,.box h6{color:#584b4f;color:var(--color-base)}.box :first-child{margin-top:0}.box :last-child{margin-bottom:0}.box__content{-ms-flex-positive:1;color:#584b4f;color:var(--color-base);flex-grow:1;text-decoration:none}.box__content p{font-size:.875rem}.box__content:hover{color:#584b4f;color:var(--color-base);text-decoration:none}.box__content:not(:last-child){margin-bottom:16px}.box__link{display:block;font-size:.75rem;text-decoration:none}.box__link,.box__link [class*=icon]{color:#4f5b93;color:var(--color-key)}.box__link:hover{color:#a2aacd;color:var(--color-key-light);text-decoration:none}code,pre,tt{font-family:SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace}code,tt{background-color:rgba(0,0,0,.05);border-radius:4px;font-size:.75rem;margin:0;padding:.3rem .45rem}code br,tt br{display:none}del code{text-decoration:inherit}pre{word-wrap:normal;font-size:.875rem;line-height:1.45;text-align:left}@media (max-width:768px){pre{font-size:.75rem}}pre>code{background:transparent;border:0;font-size:100%;margin:0;padding:0;white-space:pre;word-break:normal}.highlight{margin-bottom:16px}.highlight pre{margin-bottom:0;word-break:normal}.highlight pre,pre{background-color:#f9f9f8;background-color:var(--color-background-lightest);border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.08);box-shadow:0 1px 0 0 rgba(0,0,0,.08);-webkit-box-shadow:var(--box-shadow-lightest);box-shadow:var(--box-shadow-lightest);color:#584b4f;color:var(--color-base);overflow:auto;padding:16px 16px 14px;text-shadow:none!important}pre code,pre tt{word-wrap:normal;background-color:transparent;border:0;display:inline;line-height:inherit;margin:0;max-width:none;overflow:visible;padding:0}pre code:after,pre code:before,pre tt:after,pre tt:before{content:normal}.pl-c{color:#969896}.pl-c1,.pl-s .pl-v{color:#0086b3}.pl-e,.pl-en{color:#795da3}.pl-s .pl-s1,.pl-smi{color:#444}.pl-ent{color:#63a35c}.pl-k{color:#a71d5d}.pl-pds,.pl-s,.pl-s .pl-pse .pl-s1,.pl-sr,.pl-sr .pl-cce,.pl-sr .pl-sra,.pl-sr .pl-sre{color:#183691}.pl-smw,.pl-v{color:#ed6a43}.pl-bu{color:#b52a1d}.pl-c2,.pl-ii{background-color:#b52a1d;color:#f8f8f8}.pl-c2:before{content:"^M"}.pl-sr .pl-cce{color:#63a35c;font-weight:700}.pl-ml{color:#693a17}.pl-mh,.pl-mh .pl-en,.pl-ms{color:#1d3e81;font-weight:700}.pl-mq{color:teal}.pl-mi{color:#333;font-style:italic}.pl-mb{color:#333;font-weight:700}.pl-md{background-color:#ffecec;color:#bd2c00}.pl-mi1{background-color:#eaffea;color:#55a532}.pl-mc{background-color:#ffe3b4;color:#ef9700}.pl-mi2{background-color:grey;color:#d8d8d8}.pl-mdr{color:#795da3;font-weight:700}.pl-mo{color:#1d3e81}.pl-ba{color:#595e62}.pl-sg{color:silver}.pl-corl{color:#183691;text-decoration:underline}.anchor{display:block;float:left;padding-right:2px;position:absolute;text-decoration:none!important;-webkit-transform:translateX(-100%);transform:translateX(-100%)}.anchor:focus{outline:none}.anchor>*{visibility:hidden}:hover>.anchor>*{visibility:visible}.anchor>:before{color:#a2aacd;color:var(--color-key-light);content:"#";font-weight:400!important}.anchor--disable .anchor>*,.anchor.anchor--disable>*{visibility:hidden!important}.searchbox{width:100%}.searchbox,.searchbox:focus{-webkit-appearance:none;-moz-appearance:none;appearance:none;background:#eae8e3 url(../assets/search.17d09555.svg) no-repeat 10px;background:var(--color-background-light) url(../assets/search.17d09555.svg) no-repeat 10px center;background-size:16px 16px;border:0;border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.15);box-shadow:0 1px 0 0 rgba(0,0,0,.15);-webkit-box-shadow:var(--box-shadow-light);box-shadow:var(--box-shadow-light);color:#584b4f;color:var(--color-base);font-size:.875rem;line-height:24px;outline:none;padding:6px 8px 6px 32px;-webkit-transition:width .35s cubic-bezier(.23,1,.32,1);-o-transition:width .35s cubic-bezier(.23,1,.32,1);transition:width .35s cubic-bezier(.23,1,.32,1)}.searchbox::-webkit-input-placeholder{color:#afa1a5;color:var(--color-base-light)}.searchbox:-moz-placeholder,.searchbox::-moz-placeholder{color:#afa1a5;color:var(--color-base-light)}.searchbox::-moz-placeholder{opacity:1}.searchbox:-ms-input-placeholder{color:#afa1a5;color:var(--color-base-light)}.searchbox:focus{background-color:#f4f3f1!important;background-color:var(--color-background-lighter)!important;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter)}.searchbox--collapsed:not(:focus){background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none;cursor:pointer;margin-right:-12px;width:32px!important}.searchbox--collapsed:not(:focus)::-webkit-search-cancel-button,.searchbox--collapsed:not(:focus)::-webkit-search-decoration{display:none}.searchbox--collapsed:not(:focus)::-webkit-search-results-button,.searchbox--collapsed:not(:focus)::-webkit-search-results-decoration{display:none}.searchbox--collapsed:not(:focus)::-ms-clear{display:none}.searchbox--large,.searchbox--large:focus{padding:8px 12px 8px 40px}.alert{background-color:#f4f3f1;background-color:var(--color-background-lighter);border-left:4px solid #ba3525;border-left:4px solid var(--color-red);border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);font-size:.9em;padding:16px 16px 16px 24px;position:relative}.alert:before{background:#ba3525;background:var(--color-red);border-radius:50%;-webkit-box-sizing:border-box;box-sizing:border-box;color:#fff;content:"!";display:block;font-size:12px;font-weight:700;height:24px;left:-14px;line-height:22px;padding:0 4px;position:absolute;text-align:center;top:12px;width:24px}.alert a{color:#ba3525;color:var(--color-red)}.alert :last-child{margin-bottom:0}.toc{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;list-style:none;margin-left:-4px;padding:0}.toc li{margin:4px}.toc a{background-color:#584b4f;background-color:var(--color-base);border-radius:4px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);display:-ms-flexbox;display:flex;font-family:SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace;font-weight:bolder;letter-spacing:normal;padding:.25rem 1rem .15rem}.toc a,.toc a:hover{color:#fff;text-decoration:none}@media (max-width:768px){.toc{font-size:.85rem}}.welcome__intro{background-image:-o-radial-gradient(center,ellipse,#fff 0,#eae8e3 100%);background-image:radial-gradient(ellipse at center,#fff 0,#eae8e3 100%);background-image:-o-radial-gradient(center,ellipse,#fff 0,var(--color-background-light) 100%);background-image:radial-gradient(ellipse at center,#fff 0,var(--color-background-light) 100%);background-position:50% 0;background-size:auto 100%;border-bottom:1px dashed #eae8e3;border-bottom:1px dashed var(--color-background-light);padding:16px 0 136px}.welcome__intro h1{color:#4f5b93;color:var(--color-key);font-size:2rem;margin-bottom:16px}.welcome__logo{display:block;margin:0 auto;max-width:320px}.welcome__logo svg{display:block;height:240px}.welcome__content{display:block;max-width:calc(98% - 320px);padding-top:16px}.welcome__example{display:block;margin:-160px auto auto;max-width:850px}.welcome__example .highlight pre{background:#fff;-webkit-box-shadow:0 0 16px #d6d1c8;box-shadow:0 0 16px #d6d1c8;-webkit-box-shadow:0 0 16px var(--color-background);box-shadow:0 0 16px var(--color-background);padding:32px}.welcome__intro .links a{color:#584b4f;color:var(--color-base);text-decoration:none}.welcome__intro .links a:hover{color:#4f5b93;color:var(--color-key);text-decoration:none}.welcome__team img{border-radius:50%;display:inline-block;max-width:190px}.welcome__team h3{display:block;margin:.2em 0}.welcome__team div.grid>*{margin-bottom:1em}@media (max-width:768px){.welcome__content{max-width:100%;padding:32px 16px 16px}.welcome__logo svg{height:160px}.welcome__intro h1{color:#4f5b93;color:var(--color-key);font-size:1.75rem;margin-bottom:16px;text-align:center}.welcome__intro .links{text-align:center}}.off-canvas-menu{pointer-events:none;position:fixed;right:0;top:0}.off-canvas-menu__content{-webkit-transform:translate3d(105%,0,0);transform:translate3d(105%,0,0)}.component-info{background-color:#f4f3f1;background-color:var(--color-background-lighter);border-radius:4px;bottom:16px;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);font-size:.875rem;padding:24px;position:sticky;top:16px}.component-info,.component-info a,.component-info a [class*=icon]{color:#584b4f;color:var(--color-base)}.component-info a:hover{color:#afa1a5;color:var(--color-base-light);text-decoration:none}.component-info pre{font-size:.75rem;line-height:1}.component-info__title{-ms-flex-align:center;align-items:center;color:#584b4f;color:var(--color-base);display:-ms-flexbox;display:flex;font-size:1.5rem;line-height:1rem;margin-bottom:1rem}.component-info__title a{text-decoration:none}.component-info__title>:not(:last-child){margin-right:8px}.component-info__subtitle{color:#afa1a5;color:var(--color-base-light);font-size:.875rem;font-weight:700;letter-spacing:.1em;line-height:.875rem;margin-bottom:.875rem;text-transform:uppercase}.component-info__info{-ms-flex-pack:start;display:-ms-flexbox;display:flex;-ms-flex-flow:row;flex-flow:row;justify-content:flex-start;list-style:none;padding:0}.component-info__info li{margin-right:16px}.component-info__info li:last-child{margin-right:0}.component-info__info a{font-size:.75rem;text-decoration:none;-o-text-overflow:ellipsis;text-overflow:ellipsis;white-space:nowrap}.component-info__contributors{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;list-style:none;padding:0}.component-info__contributors li{margin:0;padding:0 4px 4px 0}.component-info__contributors img{border-radius:2px;display:block;height:auto;width:40px}.component-info__contributors img,.component-info__participation{-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter)}.component-info__participation{background-color:#f9f9f8;background-color:var(--color-background-lightest);border-radius:4px;padding:8px;text-align:center}.component-info__participation svg{display:block;height:auto!important;margin:auto;max-width:100%}:root{--color-key:#4f5b93;--color-key-light:#a2aacd;--color-base:#584b4f;--color-base-light:#afa1a5;--color-green:#40a977;--color-green-light:#9ad8bb;--color-red:#ba3525;--color-red-light:#e79187;--color-background:#d6d1c8;--color-background-light:#eae8e3;--color-background-lighter:#f4f3f1;--color-background-lightest:#f9f9f8;--box-shadow-light:0 1px 0 0 rgba(0,0,0,.15);--box-shadow-lighter:0 1px 0 0 rgba(0,0,0,.1);--box-shadow-lightest:0 1px 0 0 rgba(0,0,0,.08)}.version-selector{color:#fff;font-size:.875rem;position:relative}.version-selector :last-child{margin-bottom:0}.version-selector__button,.version-selector__version{-webkit-appearance:none;background-color:#584b4f;background-color:var(--color-base);border:0;border-radius:4px;-webkit-box-shadow:none;box-shadow:none;-webkit-box-shadow:0 1px 0 0 rgba(0,0,0,.1);box-shadow:0 1px 0 0 rgba(0,0,0,.1);-webkit-box-shadow:var(--box-shadow-lighter);box-shadow:var(--box-shadow-lighter);color:#fff;cursor:pointer;display:-ms-flexbox;display:flex;font-family:SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace;font-size:.75rem;font-weight:bolder;letter-spacing:normal;margin:0;outline:none;overflow:visible;padding:.25rem .4rem .2rem;text-decoration:none;text-shadow:none;text-transform:none}.version-selector__button{position:relative}.version-selector__button [class=icon-chevron-down]{display:inline-block;margin-left:4px}.version-selector__button [class=icon-chevron-up]{display:none;margin-left:4px}.version-selector__version{background-color:hsla(0,0%,100%,.33);border:1px solid transparent;color:#fff!important;text-decoration:none}.version-selector__version:hover{background-color:hsla(0,0%,100%,.11);border:1px solid hsla(0,0%,100%,.22)}.version-selector__button--dev,.version-selector__version--dev,.version-selector__version--dev:hover{background-color:#ba3525;background-color:var(--color-red)}.version-selector__button--latest,.version-selector__version--latest,.version-selector__version--latest:hover{background-color:#40a977;background-color:var(--color-green)}.version-selector__panel{position:fixed;top:-20000em;visibility:hidden}</style>
<script async src="../assets/main.93d54642.js"></script>
</head>
<body>
<header class="header">
<div class="wrapper">
<div class="header__container">
<a class="header__logo" href="../">
<svg xmlns="http://www.w3.org/2000/svg" width="320" height="47.29" viewBox="0 428.964 320 47.29"><path fill="#584B4F" d="M30.86 452.385c1.637-2.287 2.455-5 2.455-8.134 0-4.313-1.367-7.87-4.088-10.68-2.723-2.812-6.39-4.216-11.004-4.216h-7.71c-3.79 0-6.49.798-8.1 2.388C.806 433.332 0 435.872 0 439.355v36.512h9.08v-17.245h6.53l9.08 17.245h10.52L24.82 457.12c2.395-.87 4.41-2.447 6.04-4.735zm-8.488-3.334c-1.24 1.33-2.82 1.99-4.734 1.99H9.08v-9.47c0-2.74 1.35-4.112 4.05-4.112h4.508c2 0 3.603.61 4.8 1.83 1.196 1.22 1.797 2.82 1.797 4.802 0 1.982-.623 3.64-1.864 4.964v-.003zm20.348 14.536c0 4.572 1.055 7.766 3.167 9.57 2.114 1.81 5.782 2.71 11.008 2.71h16.46v-8.1H57.548c-2.18 0-3.68-.35-4.51-1.045-.83-.695-1.24-1.96-1.24-3.788v-6.467h14.434l.656-8.1h-15.09v-10.912h21.56v-8.098H42.72v34.23zm57.97-33.442c-.718-.523-1.665-.787-2.84-.787-1.177 0-2.168.285-2.972.85-.807.567-1.537 1.592-2.19 3.073l-14.89 42.585h9.47l2.55-8.03h15.613l2.613 8.03h9.47l-14.893-42.588c-.567-1.572-1.21-2.613-1.93-3.135v.002zM92.1 460.19l5.75-18.42 5.487 18.418H92.1v.002zm53.074 5.455c-1.155 1.678-3.245 2.512-6.27 2.512-3.03 0-5.258-.914-6.697-2.74-1.394-1.83-2.093-5.25-2.093-10.256v-4.052c0-1.783.045-3.2.13-4.243.178-3.27.785-5.576 1.833-6.928 1.48-1.914 3.745-2.873 6.794-2.873 2.613 0 4.532.653 5.75 1.96 1.218 1.308 2.07 3.245 2.547 5.813h8.49c0-5.14-1.557-9.07-4.67-11.79-3.114-2.723-7.153-4.084-12.116-4.084-3.398 0-6.293.564-8.687 1.7-6.097 2.783-9.146 9.686-9.146 20.704v3.918c0 13.982 5.945 20.968 17.833 20.968 5.4 0 9.58-1.59 12.54-4.77 2.964-3.176 4.44-7.73 4.44-13.653h-8.426c-.346 3.53-1.1 6.134-2.25 7.81v.005zm14.667-36.29v8.1h12.412v38.41h9.08v-38.41h12.47v-8.1"/><path fill="#4F5B93" d="M218.89 429.356h-18.03v46.51h9.086v-14.897h8.944c4.876 0 8.647-1.337 11.328-4.016 2.683-2.68 4.02-6.608 4.02-11.788s-1.337-9.112-4.02-11.788c-2.68-2.68-6.454-4.02-11.328-4.02v-.002zm4.538 21.686c-1.15 1.177-2.815 1.768-5 1.768h-8.485v-15.354h8.484c4.483 0 6.73 2.572 6.73 7.71 0 2.744-.578 4.703-1.73 5.88v-.004zm43.93-2.02H250.31v-19.666h-9.088v46.51h9.086v-18.81h17.05v18.81h9.076v-46.51h-9.078m48.63 4.02c-2.683-2.68-6.46-4.02-11.335-4.02h-18.027v46.507h9.085V460.97h8.943c4.877 0 8.654-1.336 11.337-4.014 2.68-2.678 4.013-6.608 4.013-11.788s-1.332-9.112-4.013-11.79v-.003zm-6.795 17.666c-1.154 1.177-2.822 1.768-5 1.768h-8.484v-15.354h8.485c4.483 0 6.734 2.572 6.734 7.71 0 2.744-.583 4.703-1.735 5.88v-.004z"/></svg>
</a>
<form class="header__search">
<input type="search" class="searchbox searchbox--collapsed" data-docsearch placeholder="Search documentation...">
</form>
<div class="header__menu">
<button class="hamburger" data-ctrly="off-canvas-menu" data-off-canvas-menu-control>
<div class="hamburger__box">
<div class="hamburger__inner">
<span class="visually-hidden">Menu</span>
</div>
</div>
</button>
</div>
<nav id="off-canvas-menu" class="off-canvas-menu" aria-hidden="true" tabindex="0">
<div class="off-canvas-menu__content">
<button aria-label="Close menu" class="off-canvas-menu__close" data-ctrly="off-canvas-menu" data-off-canvas-menu-control>
<i class="icon-x" aria-hidden="true"></i>
</button>
<section class="off-canvas-menu__section">
<a class="off-canvas-menu__section-top" href="../">Home</a>
</section>
<section class="off-canvas-menu__section">
<a class="off-canvas-menu__section-top" href="../changelog.html">Changelog</a>
</section>
<section class="off-canvas-menu__section">
<h3 class="off-canvas-menu__section-header">Core Components</h3>
<ul class="off-canvas-menu__list">
<li>
<a class="off-canvas-menu__link" href="../event-loop/">
EventLoop
<span class="off-canvas-menu__version">
v1.6.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../stream/">
Stream
<span class="off-canvas-menu__version">
v1.4.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../promise/">
Promise
<span class="off-canvas-menu__version">
v3.3.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../async/">
Async
<span class="off-canvas-menu__version">
v4.3.0
</span>
</a>
</li>
</ul>
</section>
<section class="off-canvas-menu__section">
<h3 class="off-canvas-menu__section-header">Network Components</h3>
<ul class="off-canvas-menu__list">
<li>
<a class="off-canvas-menu__link" href="../socket/">
Socket
<span class="off-canvas-menu__version">
v1.17.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../datagram/">
Datagram
<span class="off-canvas-menu__version">
v1.10.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../http/">
HTTP
<span class="off-canvas-menu__version">
v1.11.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../dns/">
DNS
<span class="off-canvas-menu__version">
v1.14.0
</span>
</a>
</li>
</ul>
</section>
<section class="off-canvas-menu__section">
<h3 class="off-canvas-menu__section-header">Utility Components</h3>
<ul class="off-canvas-menu__list">
<li>
<a class="off-canvas-menu__link" href="../cache/">
Cache
<span class="off-canvas-menu__version">
v1.2.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../child-process/">
ChildProcess
<span class="off-canvas-menu__version">
v0.6.7
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../promise-timer/">
PromiseTimer
<span class="off-canvas-menu__version">
v1.11.0
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../promise-stream/">
PromiseStream
<span class="off-canvas-menu__version">
v1.7.0
</span>
</a>
</li>
</ul>
</section>
<section class="off-canvas-menu__section">
<h3 class="off-canvas-menu__section-header">Legacy Components</h3>
<ul class="off-canvas-menu__list">
<li>
<a class="off-canvas-menu__link" href="../http-client/">
HttpClient
<span class="off-canvas-menu__version">
v0.5.11
</span>
</a>
</li>
<li>
<a class="off-canvas-menu__link" href="../socket-client/">
SocketClient
<span class="off-canvas-menu__version">
v0.7.0
</span>
</a>
</li>
</ul>
</section>
</div>
</nav>
</div>
</div>
</header>
<div class="container">
<div class="wrapper">
<div class="grid grid--wrap grid--gutter">
<main class="main">
<h1>Socket</h1>
<div class="markdown-heading"><h1 class="heading-element">Socket</h1><a id="socket" class="anchor" aria-label="Permalink: Socket" href="#socket"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p><a href="https://github.com/reactphp/socket/actions"><img src="https://github.com/reactphp/socket/workflows/CI/badge.svg" alt="CI status" style="max-width: 100%;"></a>
<a href="https://packagist.org/packages/react/socket" rel="nofollow"><img src="https://camo.githubusercontent.com/3f02c3315ed7df5a2a00059a3013282778fd757909c8fa457c570525ac220b3b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f72656163742f736f636b65743f636f6c6f723d626c7565266c6162656c3d696e7374616c6c732532306f6e2532305061636b6167697374" alt="installs on Packagist" data-canonical-src="https://img.shields.io/packagist/dt/react/socket?color=blue&label=installs%20on%20Packagist" style="max-width: 100%;"></a></p>
<p>Async, streaming plaintext TCP/IP and secure TLS socket server and client
connections for <a href="https://reactphp.org/" rel="nofollow">ReactPHP</a>.</p>
<p>The socket library provides re-usable interfaces for a socket-layer
server and client based on the <a href="../event-loop/"><code>EventLoop</code></a>
and <a href="../stream/"><code>Stream</code></a> components.
Its server component allows you to build networking servers that accept incoming
connections from networking clients (such as an HTTP server).
Its client component allows you to build networking clients that establish
outgoing connections to networking servers (such as an HTTP or database client).
This library provides async, streaming means for all of this, so you can
handle multiple concurrent connections without blocking.</p>
<p><strong>Table of Contents</strong></p>
<ul>
<li><a href="#quickstart-example">Quickstart example</a></li>
<li>
<a href="#connection-usage">Connection usage</a>
<ul>
<li>
<a href="#connectioninterface">ConnectionInterface</a>
<ul>
<li><a href="#getremoteaddress">getRemoteAddress()</a></li>
<li><a href="#getlocaladdress">getLocalAddress()</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#server-usage">Server usage</a>
<ul>
<li>
<a href="#serverinterface">ServerInterface</a>
<ul>
<li><a href="#connection-event">connection event</a></li>
<li><a href="#error-event">error event</a></li>
<li><a href="#getaddress">getAddress()</a></li>
<li><a href="#pause">pause()</a></li>
<li><a href="#resume">resume()</a></li>
<li><a href="#close">close()</a></li>
</ul>
</li>
<li><a href="#socketserver">SocketServer</a></li>
<li>
<a href="#advanced-server-usage">Advanced server usage</a>
<ul>
<li><a href="#tcpserver">TcpServer</a></li>
<li><a href="#secureserver">SecureServer</a></li>
<li><a href="#unixserver">UnixServer</a></li>
<li>
<a href="#limitingserver">LimitingServer</a>
<ul>
<li><a href="#getconnections">getConnections()</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#client-usage">Client usage</a>
<ul>
<li>
<a href="#connectorinterface">ConnectorInterface</a>
<ul>
<li><a href="#connect">connect()</a></li>
</ul>
</li>
<li><a href="#connector">Connector</a></li>
<li>
<a href="#advanced-client-usage">Advanced client usage</a>
<ul>
<li><a href="#tcpconnector">TcpConnector</a></li>
<li><a href="#happyeyeballsconnector">HappyEyeBallsConnector</a></li>
<li><a href="#dnsconnector">DnsConnector</a></li>
<li><a href="#secureconnector">SecureConnector</a></li>
<li><a href="#timeoutconnector">TimeoutConnector</a></li>
<li><a href="#unixconnector">UnixConnector</a></li>
<li><a href="#fixeduriconnector">FixUriConnector</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#install">Install</a></li>
<li><a href="#tests">Tests</a></li>
<li><a href="#license">License</a></li>
</ul>
<div class="markdown-heading"><h2 class="heading-element">Quickstart example</h2><a id="quickstart-example" class="anchor" aria-label="Permalink: Quickstart example" href="#quickstart-example"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>Here is a server that closes the connection if you send it anything:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:8080</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">"<span class="pl-s">Hello </span>"</span> . <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>() . <span class="pl-s">"<span class="pl-s">!</span>\n"</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">"<span class="pl-s">Welcome to this amazing server!</span>\n"</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">"<span class="pl-s">Here's a tip: don't say anything.</span>\n"</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">data</span>'</span>, <span class="pl-k">function</span> (<span class="pl-s1"><span class="pl-c1">$</span>data</span>) <span class="pl-k">use</span> (<span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">close</span>();
});
});</pre></div>
<p>See also the <a href="https://github.com/reactphp/socket/blob/v1.17.0/examples">examples</a>.</p>
<p>Here's a client that outputs the output of said server and then attempts to
send it a string:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>();
<span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:8080</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">pipe</span>(<span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Stream</span>\<span class="pl-v">WritableResourceStream</span>(<span class="pl-c1">STDOUT</span>));
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">"<span class="pl-s">Hello World!</span>\n"</span>);
}, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>e</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Error: </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>e</span>-><span class="pl-en">getMessage</span>() . <span class="pl-c1">PHP_EOL</span>;
});</pre></div>
<div class="markdown-heading"><h2 class="heading-element">Connection usage</h2><a id="connection-usage" class="anchor" aria-label="Permalink: Connection usage" href="#connection-usage"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<div class="markdown-heading"><h3 class="heading-element">ConnectionInterface</h3><a id="connectioninterface" class="anchor" aria-label="Permalink: ConnectionInterface" href="#connectioninterface"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>ConnectionInterface</code> is used to represent any incoming and outgoing
connection, such as a normal TCP/IP connection.</p>
<p>An incoming or outgoing connection is a duplex stream (both readable and
writable) that implements React's
<a href="../stream/#duplexstreaminterface"><code>DuplexStreamInterface</code></a>.
It contains additional properties for the local and remote address (client IP)
where this connection has been established to/from.</p>
<p>Most commonly, instances implementing this <code>ConnectionInterface</code> are emitted
by all classes implementing the <a href="#serverinterface"><code>ServerInterface</code></a> and
used by all classes implementing the <a href="#connectorinterface"><code>ConnectorInterface</code></a>.</p>
<p>Because the <code>ConnectionInterface</code> implements the underlying
<a href="../stream/#duplexstreaminterface"><code>DuplexStreamInterface</code></a>
you can use any of its events and methods as usual:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">data</span>'</span>, <span class="pl-k">function</span> (<span class="pl-s1"><span class="pl-c1">$</span>chunk</span>) {
<span class="pl-k">echo</span> <span class="pl-s1"><span class="pl-c1">$</span>chunk</span>;
});
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">end</span>'</span>, <span class="pl-k">function</span> () {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">ended</span>'</span>;
});
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">error</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>e</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">error: </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>e</span>-><span class="pl-en">getMessage</span>();
});
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">close</span>'</span>, <span class="pl-k">function</span> () {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">closed</span>'</span>;
});
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s1"><span class="pl-c1">$</span>data</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>(<span class="pl-s1"><span class="pl-c1">$</span>data</span> = <span class="pl-c1">null</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">close</span>();
<span class="pl-c">// …</span></pre></div>
<p>For more details, see the
<a href="../stream/#duplexstreaminterface"><code>DuplexStreamInterface</code></a>.</p>
<div class="markdown-heading"><h4 class="heading-element">getRemoteAddress()</h4><a id="getremoteaddress" class="anchor" aria-label="Permalink: getRemoteAddress()" href="#getremoteaddress"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>getRemoteAddress(): ?string</code> method returns the full remote address
(URI) where this connection has been established with.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>();
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Connection with </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>address</span> . <span class="pl-c1">PHP_EOL</span>;</pre></div>
<p>If the remote address can not be determined or is unknown at this time (such as
after the connection has been closed), it MAY return a <code>NULL</code> value instead.</p>
<p>Otherwise, it will return the full address (URI) as a string value, such
as <code>tcp://127.0.0.1:8080</code>, <code>tcp://[::1]:80</code>, <code>tls://127.0.0.1:443</code>,
<code>unix://example.sock</code> or <code>unix:///path/to/example.sock</code>.
Note that individual URI components are application specific and depend
on the underlying transport protocol.</p>
<p>If this is a TCP/IP based connection and you only want the remote IP, you may
use something like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>();
<span class="pl-s1"><span class="pl-c1">$</span>ip</span> = <span class="pl-en">trim</span>(<span class="pl-en">parse_url</span>(<span class="pl-s1"><span class="pl-c1">$</span>address</span>, <span class="pl-c1">PHP_URL_HOST</span>), <span class="pl-s">'<span class="pl-s">[]</span>'</span>);
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Connection with </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>ip</span> . <span class="pl-c1">PHP_EOL</span>;</pre></div>
<div class="markdown-heading"><h4 class="heading-element">getLocalAddress()</h4><a id="getlocaladdress" class="anchor" aria-label="Permalink: getLocalAddress()" href="#getlocaladdress"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>getLocalAddress(): ?string</code> method returns the full local address
(URI) where this connection has been established with.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getLocalAddress</span>();
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Connection with </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>address</span> . <span class="pl-c1">PHP_EOL</span>;</pre></div>
<p>If the local address can not be determined or is unknown at this time (such as
after the connection has been closed), it MAY return a <code>NULL</code> value instead.</p>
<p>Otherwise, it will return the full address (URI) as a string value, such
as <code>tcp://127.0.0.1:8080</code>, <code>tcp://[::1]:80</code>, <code>tls://127.0.0.1:443</code>,
<code>unix://example.sock</code> or <code>unix:///path/to/example.sock</code>.
Note that individual URI components are application specific and depend
on the underlying transport protocol.</p>
<p>This method complements the <a href="#getremoteaddress"><code>getRemoteAddress()</code></a> method,
so they should not be confused.</p>
<p>If your <code>TcpServer</code> instance is listening on multiple interfaces (e.g. using
the address <code>0.0.0.0</code>), you can use this method to find out which interface
actually accepted this connection (such as a public or local interface).</p>
<p>If your system has multiple interfaces (e.g. a WAN and a LAN interface),
you can use this method to find out which interface was actually
used for this connection.</p>
<div class="markdown-heading"><h2 class="heading-element">Server usage</h2><a id="server-usage" class="anchor" aria-label="Permalink: Server usage" href="#server-usage"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<div class="markdown-heading"><h3 class="heading-element">ServerInterface</h3><a id="serverinterface" class="anchor" aria-label="Permalink: ServerInterface" href="#serverinterface"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>ServerInterface</code> is responsible for providing an interface for accepting
incoming streaming connections, such as a normal TCP/IP connection.</p>
<p>Most higher-level components (such as a HTTP server) accept an instance
implementing this interface to accept incoming streaming connections.
This is usually done via dependency injection, so it's fairly simple to actually
swap this implementation against any other implementation of this interface.
This means that you SHOULD typehint against this interface instead of a concrete
implementation of this interface.</p>
<p>Besides defining a few methods, this interface also implements the
<a href="https://github.com/igorw/evenement"><code>EventEmitterInterface</code></a>
which allows you to react to certain events.</p>
<div class="markdown-heading"><h4 class="heading-element">connection event</h4><a id="connection-event" class="anchor" aria-label="Permalink: connection event" href="#connection-event"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>connection</code> event will be emitted whenever a new connection has been
established, i.e. a new client connects to this server socket:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">new connection</span>'</span> . <span class="pl-c1">PHP_EOL</span>;
});</pre></div>
<p>See also the <a href="#connectioninterface"><code>ConnectionInterface</code></a> for more details
about handling the incoming connection.</p>
<div class="markdown-heading"><h4 class="heading-element">error event</h4><a id="error-event" class="anchor" aria-label="Permalink: error event" href="#error-event"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>error</code> event will be emitted whenever there's an error accepting a new
connection from a client.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">error</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>e</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">error: </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>e</span>-><span class="pl-en">getMessage</span>() . <span class="pl-c1">PHP_EOL</span>;
});</pre></div>
<p>Note that this is not a fatal error event, i.e. the server keeps listening for
new connections even after this event.</p>
<div class="markdown-heading"><h4 class="heading-element">getAddress()</h4><a id="getaddress" class="anchor" aria-label="Permalink: getAddress()" href="#getaddress"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>getAddress(): ?string</code> method can be used to
return the full address (URI) this server is currently listening on.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">getAddress</span>();
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Server listening on </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>address</span> . <span class="pl-c1">PHP_EOL</span>;</pre></div>
<p>If the address can not be determined or is unknown at this time (such as
after the socket has been closed), it MAY return a <code>NULL</code> value instead.</p>
<p>Otherwise, it will return the full address (URI) as a string value, such
as <code>tcp://127.0.0.1:8080</code>, <code>tcp://[::1]:80</code>, <code>tls://127.0.0.1:443</code>
<code>unix://example.sock</code> or <code>unix:///path/to/example.sock</code>.
Note that individual URI components are application specific and depend
on the underlying transport protocol.</p>
<p>If this is a TCP/IP based server and you only want the local port, you may
use something like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">getAddress</span>();
<span class="pl-s1"><span class="pl-c1">$</span>port</span> = <span class="pl-en">parse_url</span>(<span class="pl-s1"><span class="pl-c1">$</span>address</span>, <span class="pl-c1">PHP_URL_PORT</span>);
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Server listening on port </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>port</span> . <span class="pl-c1">PHP_EOL</span>;</pre></div>
<div class="markdown-heading"><h4 class="heading-element">pause()</h4><a id="pause" class="anchor" aria-label="Permalink: pause()" href="#pause"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>pause(): void</code> method can be used to
pause accepting new incoming connections.</p>
<p>Removes the socket resource from the EventLoop and thus stop accepting
new connections. Note that the listening socket stays active and is not
closed.</p>
<p>This means that new incoming connections will stay pending in the
operating system backlog until its configurable backlog is filled.
Once the backlog is filled, the operating system may reject further
incoming connections until the backlog is drained again by resuming
to accept new connections.</p>
<p>Once the server is paused, no futher <code>connection</code> events SHOULD
be emitted.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">pause</span>();
<span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-en">assertShouldNeverCalled</span>());</pre></div>
<p>This method is advisory-only, though generally not recommended, the
server MAY continue emitting <code>connection</code> events.</p>
<p>Unless otherwise noted, a successfully opened server SHOULD NOT start
in paused state.</p>
<p>You can continue processing events by calling <code>resume()</code> again.</p>
<p>Note that both methods can be called any number of times, in particular
calling <code>pause()</code> more than once SHOULD NOT have any effect.
Similarly, calling this after <code>close()</code> is a NO-OP.</p>
<div class="markdown-heading"><h4 class="heading-element">resume()</h4><a id="resume" class="anchor" aria-label="Permalink: resume()" href="#resume"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>resume(): void</code> method can be used to
resume accepting new incoming connections.</p>
<p>Re-attach the socket resource to the EventLoop after a previous <code>pause()</code>.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">pause</span>();
Loop::<span class="pl-en">addTimer</span>(<span class="pl-c1">1.0</span>, <span class="pl-k">function</span> () <span class="pl-k">use</span> (<span class="pl-s1"><span class="pl-c1">$</span>socket</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">resume</span>();
});</pre></div>
<p>Note that both methods can be called any number of times, in particular
calling <code>resume()</code> without a prior <code>pause()</code> SHOULD NOT have any effect.
Similarly, calling this after <code>close()</code> is a NO-OP.</p>
<div class="markdown-heading"><h4 class="heading-element">close()</h4><a id="close" class="anchor" aria-label="Permalink: close()" href="#close"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>close(): void</code> method can be used to
shut down this listening socket.</p>
<p>This will stop listening for new incoming connections on this socket.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Shutting down server socket</span>'</span> . <span class="pl-c1">PHP_EOL</span>;
<span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">close</span>();</pre></div>
<p>Calling this method more than once on the same instance is a NO-OP.</p>
<div class="markdown-heading"><h3 class="heading-element">SocketServer</h3><a id="socketserver" class="anchor" aria-label="Permalink: SocketServer" href="#socketserver"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p><a id="server"></a> </p>
<p>The <code>SocketServer</code> class is the main class in this package that implements the
<a href="#serverinterface"><code>ServerInterface</code></a> and allows you to accept incoming
streaming connections, such as plaintext TCP/IP or secure TLS connection streams.</p>
<p>In order to accept plaintext TCP/IP connections, you can simply pass a host
and port combination like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:8080</span>'</span>);</pre></div>
<p>Listening on the localhost address <code>127.0.0.1</code> means it will not be reachable from
outside of this system.
In order to change the host the socket is listening on, you can provide an IP
address of an interface or use the special <code>0.0.0.0</code> address to listen on all
interfaces:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">0.0.0.0:8080</span>'</span>);</pre></div>
<p>If you want to listen on an IPv6 address, you MUST enclose the host in square
brackets:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">[::1]:8080</span>'</span>);</pre></div>
<p>In order to use a random port assignment, you can use the port <code>0</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:0</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">getAddress</span>();</pre></div>
<p>To listen on a Unix domain socket (UDS) path, you MUST prefix the URI with the
<code>unix://</code> scheme:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">unix:///tmp/server.sock</span>'</span>);</pre></div>
<p>In order to listen on an existing file descriptor (FD) number, you MUST prefix
the URI with <code>php://fd/</code> like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">php://fd/3</span>'</span>);</pre></div>
<p>If the given URI is invalid, does not contain a port, any other scheme or if it
contains a hostname, it will throw an <code>InvalidArgumentException</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-c">// throws InvalidArgumentException due to missing port</span>
<span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1</span>'</span>);</pre></div>
<p>If the given URI appears to be valid, but listening on it fails (such as if port
is already in use or port below 1024 may require root access etc.), it will
throw a <code>RuntimeException</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>first</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:8080</span>'</span>);
<span class="pl-c">// throws RuntimeException because port is already in use</span>
<span class="pl-s1"><span class="pl-c1">$</span>second</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:8080</span>'</span>);</pre></div>
<blockquote>
<p>Note that these error conditions may vary depending on your system and/or
configuration.
See the exception message and code for more details about the actual error
condition.</p>
</blockquote>
<p>Optionally, you can specify <a href="https://www.php.net/manual/en/context.socket.php" rel="nofollow">TCP socket context options</a>
for the underlying stream socket resource like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">[::1]:8080</span>'</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">tcp</span>'</span> => <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">backlog</span>'</span> => <span class="pl-c1">200</span>,
<span class="pl-s">'<span class="pl-s">so_reuseport</span>'</span> => <span class="pl-c1">true</span>,
<span class="pl-s">'<span class="pl-s">ipv6_v6only</span>'</span> => <span class="pl-c1">true</span>
)
));</pre></div>
<blockquote>
<p>Note that available <a href="https://www.php.net/manual/en/context.socket.php" rel="nofollow">socket context options</a>,
their defaults and effects of changing these may vary depending on your system
and/or PHP version.
Passing unknown context options has no effect.
The <code>backlog</code> context option defaults to <code>511</code> unless given explicitly.</p>
</blockquote>
<p>You can start a secure TLS (formerly known as SSL) server by simply prepending
the <code>tls://</code> URI scheme.
Internally, it will wait for plaintext TCP/IP connections and then performs a
TLS handshake for each connection.
It thus requires valid <a href="https://www.php.net/manual/en/context.ssl.php" rel="nofollow">TLS context options</a>,
which in its most basic form may look something like this if you're using a
PEM encoded certificate file:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">tls://127.0.0.1:8080</span>'</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">tls</span>'</span> => <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>
)
));</pre></div>
<blockquote>
<p>Note that the certificate file will not be loaded on instantiation but when an
incoming connection initializes its TLS context.
This implies that any invalid certificate file paths or contents will only cause
an <code>error</code> event at a later time.</p>
</blockquote>
<p>If your private key is encrypted with a passphrase, you have to specify it
like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">tls://127.0.0.1:8000</span>'</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">tls</span>'</span> => <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>,
<span class="pl-s">'<span class="pl-s">passphrase</span>'</span> => <span class="pl-s">'<span class="pl-s">secret</span>'</span>
)
));</pre></div>
<p>By default, this server supports TLSv1.0+ and excludes support for legacy
SSLv2/SSLv3. As of PHP 5.6+ you can also explicitly choose the TLS version you
want to negotiate with the remote side:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SocketServer</span>(<span class="pl-s">'<span class="pl-s">tls://127.0.0.1:8000</span>'</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">tls</span>'</span> => <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>,
<span class="pl-s">'<span class="pl-s">crypto_method</span>'</span> => STREAM_CRYPTO_METHOD_TLSv1_2_SERVER
)
));</pre></div>
<blockquote>
<p>Note that available <a href="https://www.php.net/manual/en/context.ssl.php" rel="nofollow">TLS context options</a>,
their defaults and effects of changing these may vary depending on your system
and/or PHP version.
The outer context array allows you to also use <code>tcp</code> (and possibly more)
context options at the same time.
Passing unknown context options has no effect.
If you do not use the <code>tls://</code> scheme, then passing <code>tls</code> context options
has no effect.</p>
</blockquote>
<p>Whenever a client connects, it will emit a <code>connection</code> event with a connection
instance implementing <a href="#connectioninterface"><code>ConnectionInterface</code></a>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>socket</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Plaintext connection from </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>() . <span class="pl-c1">PHP_EOL</span>;
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>See also the <a href="#serverinterface"><code>ServerInterface</code></a> for more details.</p>
<p>This class takes an optional <code>LoopInterface|null $loop</code> parameter that can be used to
pass the event loop instance to use for this object. You can use a <code>null</code> value
here in order to use the <a href="../event-loop/#loop">default loop</a>.
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance.</p>
<blockquote>
<p>Note that the <code>SocketServer</code> class is a concrete implementation for TCP/IP sockets.
If you want to typehint in your higher-level protocol implementation, you SHOULD
use the generic <a href="#serverinterface"><code>ServerInterface</code></a> instead.</p>
</blockquote>
<blockquote>
<p>Changelog v1.9.0: This class has been added with an improved constructor signature
as a replacement for the previous <code>Server</code> class in order to avoid any ambiguities.
The previous name has been deprecated and should not be used anymore.</p>
</blockquote>
<div class="markdown-heading"><h3 class="heading-element">Advanced server usage</h3><a id="advanced-server-usage" class="anchor" aria-label="Permalink: Advanced server usage" href="#advanced-server-usage"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<div class="markdown-heading"><h4 class="heading-element">TcpServer</h4><a id="tcpserver" class="anchor" aria-label="Permalink: TcpServer" href="#tcpserver"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>TcpServer</code> class implements the <a href="#serverinterface"><code>ServerInterface</code></a> and
is responsible for accepting plaintext TCP/IP connections.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8080</span>);</pre></div>
<p>As above, the <code>$uri</code> parameter can consist of only a port, in which case the
server will default to listening on the localhost address <code>127.0.0.1</code>,
which means it will not be reachable from outside of this system.</p>
<p>In order to use a random port assignment, you can use the port <code>0</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">0</span>);
<span class="pl-s1"><span class="pl-c1">$</span>address</span> = <span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">getAddress</span>();</pre></div>
<p>In order to change the host the socket is listening on, you can provide an IP
address through the first parameter provided to the constructor, optionally
preceded by the <code>tcp://</code> scheme:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-s">'<span class="pl-s">192.168.0.1:8080</span>'</span>);</pre></div>
<p>If you want to listen on an IPv6 address, you MUST enclose the host in square
brackets:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-s">'<span class="pl-s">[::1]:8080</span>'</span>);</pre></div>
<p>If the given URI is invalid, does not contain a port, any other scheme or if it
contains a hostname, it will throw an <code>InvalidArgumentException</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-c">// throws InvalidArgumentException due to missing port</span>
<span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1</span>'</span>);</pre></div>
<p>If the given URI appears to be valid, but listening on it fails (such as if port
is already in use or port below 1024 may require root access etc.), it will
throw a <code>RuntimeException</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>first</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8080</span>);
<span class="pl-c">// throws RuntimeException because port is already in use</span>
<span class="pl-s1"><span class="pl-c1">$</span>second</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8080</span>);</pre></div>
<blockquote>
<p>Note that these error conditions may vary depending on your system and/or
configuration.
See the exception message and code for more details about the actual error
condition.</p>
</blockquote>
<p>This class takes an optional <code>LoopInterface|null $loop</code> parameter that can be used to
pass the event loop instance to use for this object. You can use a <code>null</code> value
here in order to use the <a href="../event-loop/#loop">default loop</a>.
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance.</p>
<p>Optionally, you can specify <a href="https://www.php.net/manual/en/context.socket.php" rel="nofollow">socket context options</a>
for the underlying stream socket resource like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-s">'<span class="pl-s">[::1]:8080</span>'</span>, <span class="pl-c1">null</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">backlog</span>'</span> => <span class="pl-c1">200</span>,
<span class="pl-s">'<span class="pl-s">so_reuseport</span>'</span> => <span class="pl-c1">true</span>,
<span class="pl-s">'<span class="pl-s">ipv6_v6only</span>'</span> => <span class="pl-c1">true</span>
));</pre></div>
<blockquote>
<p>Note that available <a href="https://www.php.net/manual/en/context.socket.php" rel="nofollow">socket context options</a>,
their defaults and effects of changing these may vary depending on your system
and/or PHP version.
Passing unknown context options has no effect.
The <code>backlog</code> context option defaults to <code>511</code> unless given explicitly.</p>
</blockquote>
<p>Whenever a client connects, it will emit a <code>connection</code> event with a connection
instance implementing <a href="#connectioninterface"><code>ConnectionInterface</code></a>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Plaintext connection from </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>() . <span class="pl-c1">PHP_EOL</span>;
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>See also the <a href="#serverinterface"><code>ServerInterface</code></a> for more details.</p>
<div class="markdown-heading"><h4 class="heading-element">SecureServer</h4><a id="secureserver" class="anchor" aria-label="Permalink: SecureServer" href="#secureserver"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>SecureServer</code> class implements the <a href="#serverinterface"><code>ServerInterface</code></a>
and is responsible for providing a secure TLS (formerly known as SSL) server.</p>
<p>It does so by wrapping a <a href="#tcpserver"><code>TcpServer</code></a> instance which waits for plaintext
TCP/IP connections and then performs a TLS handshake for each connection.
It thus requires valid <a href="https://www.php.net/manual/en/context.ssl.php" rel="nofollow">TLS context options</a>,
which in its most basic form may look something like this if you're using a
PEM encoded certificate file:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8000</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SecureServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">null</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>
));</pre></div>
<blockquote>
<p>Note that the certificate file will not be loaded on instantiation but when an
incoming connection initializes its TLS context.
This implies that any invalid certificate file paths or contents will only cause
an <code>error</code> event at a later time.</p>
</blockquote>
<p>If your private key is encrypted with a passphrase, you have to specify it
like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8000</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SecureServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">null</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>,
<span class="pl-s">'<span class="pl-s">passphrase</span>'</span> => <span class="pl-s">'<span class="pl-s">secret</span>'</span>
));</pre></div>
<p>By default, this server supports TLSv1.0+ and excludes support for legacy
SSLv2/SSLv3. As of PHP 5.6+ you can also explicitly choose the TLS version you
want to negotiate with the remote side:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">TcpServer</span>(<span class="pl-c1">8000</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">SecureServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">null</span>, <span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">local_cert</span>'</span> => <span class="pl-s">'<span class="pl-s">server.pem</span>'</span>,
<span class="pl-s">'<span class="pl-s">crypto_method</span>'</span> => STREAM_CRYPTO_METHOD_TLSv1_2_SERVER
));</pre></div>
<blockquote>
<p>Note that available <a href="https://www.php.net/manual/en/context.ssl.php" rel="nofollow">TLS context options</a>,
their defaults and effects of changing these may vary depending on your system
and/or PHP version.
Passing unknown context options has no effect.</p>
</blockquote>
<p>Whenever a client completes the TLS handshake, it will emit a <code>connection</code> event
with a connection instance implementing <a href="#connectioninterface"><code>ConnectionInterface</code></a>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Secure connection from</span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">getRemoteAddress</span>() . <span class="pl-c1">PHP_EOL</span>;
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>Whenever a client fails to perform a successful TLS handshake, it will emit an
<code>error</code> event and then close the underlying TCP/IP connection:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">error</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>e</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Error</span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>e</span>-><span class="pl-en">getMessage</span>() . <span class="pl-c1">PHP_EOL</span>;
});</pre></div>
<p>See also the <a href="#serverinterface"><code>ServerInterface</code></a> for more details.</p>
<p>Note that the <code>SecureServer</code> class is a concrete implementation for TLS sockets.
If you want to typehint in your higher-level protocol implementation, you SHOULD
use the generic <a href="#serverinterface"><code>ServerInterface</code></a> instead.</p>
<p>This class takes an optional <code>LoopInterface|null $loop</code> parameter that can be used to
pass the event loop instance to use for this object. You can use a <code>null</code> value
here in order to use the <a href="../event-loop/#loop">default loop</a>.
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance.</p>
<blockquote>
<p>Advanced usage: Despite allowing any <code>ServerInterface</code> as first parameter,
you SHOULD pass a <code>TcpServer</code> instance as first parameter, unless you
know what you're doing.
Internally, the <code>SecureServer</code> has to set the required TLS context options on
the underlying stream resources.
These resources are not exposed through any of the interfaces defined in this
package, but only through the internal <code>Connection</code> class.
The <code>TcpServer</code> class is guaranteed to emit connections that implement
the <code>ConnectionInterface</code> and uses the internal <code>Connection</code> class in order to
expose these underlying resources.
If you use a custom <code>ServerInterface</code> and its <code>connection</code> event does not
meet this requirement, the <code>SecureServer</code> will emit an <code>error</code> event and
then close the underlying connection.</p>
</blockquote>
<div class="markdown-heading"><h4 class="heading-element">UnixServer</h4><a id="unixserver" class="anchor" aria-label="Permalink: UnixServer" href="#unixserver"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>UnixServer</code> class implements the <a href="#serverinterface"><code>ServerInterface</code></a> and
is responsible for accepting connections on Unix domain sockets (UDS).</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">UnixServer</span>(<span class="pl-s">'<span class="pl-s">/tmp/server.sock</span>'</span>);</pre></div>
<p>As above, the <code>$uri</code> parameter can consist of only a socket path or socket path
prefixed by the <code>unix://</code> scheme.</p>
<p>If the given URI appears to be valid, but listening on it fails (such as if the
socket is already in use or the file not accessible etc.), it will throw a
<code>RuntimeException</code>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>first</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">UnixServer</span>(<span class="pl-s">'<span class="pl-s">/tmp/same.sock</span>'</span>);
<span class="pl-c">// throws RuntimeException because socket is already in use</span>
<span class="pl-s1"><span class="pl-c1">$</span>second</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">UnixServer</span>(<span class="pl-s">'<span class="pl-s">/tmp/same.sock</span>'</span>);</pre></div>
<blockquote>
<p>Note that these error conditions may vary depending on your system and/or
configuration.
In particular, Zend PHP does only report "Unknown error" when the UDS path
already exists and can not be bound. You may want to check <code>is_file()</code> on the
given UDS path to report a more user-friendly error message in this case.
See the exception message and code for more details about the actual error
condition.</p>
</blockquote>
<p>This class takes an optional <code>LoopInterface|null $loop</code> parameter that can be used to
pass the event loop instance to use for this object. You can use a <code>null</code> value
here in order to use the <a href="../event-loop/#loop">default loop</a>.
This value SHOULD NOT be given unless you're sure you want to explicitly use a
given event loop instance.</p>
<p>Whenever a client connects, it will emit a <code>connection</code> event with a connection
instance implementing <a href="#connectioninterface"><code>ConnectionInterface</code></a>:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">New connection</span>'</span> . <span class="pl-c1">PHP_EOL</span>;
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>See also the <a href="#serverinterface"><code>ServerInterface</code></a> for more details.</p>
<div class="markdown-heading"><h4 class="heading-element">LimitingServer</h4><a id="limitingserver" class="anchor" aria-label="Permalink: LimitingServer" href="#limitingserver"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>LimitingServer</code> decorator wraps a given <code>ServerInterface</code> and is responsible
for limiting and keeping track of open connections to this server instance.</p>
<p>Whenever the underlying server emits a <code>connection</code> event, it will check its
limits and then either</p>
<ul>
<li>keep track of this connection by adding it to the list of
open connections and then forward the <code>connection</code> event</li>
<li>or reject (close) the connection when its limits are exceeded and will
forward an <code>error</code> event instead.</li>
</ul>
<p>Whenever a connection closes, it will remove this connection from the list of
open connections.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">LimitingServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">100</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>See also the <a href="https://github.com/reactphp/socket/blob/v1.17.0/examples">second example</a> for more details.</p>
<p>You have to pass a maximum number of open connections to ensure
the server will automatically reject (close) connections once this limit
is exceeded. In this case, it will emit an <code>error</code> event to inform about
this and no <code>connection</code> event will be emitted.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">LimitingServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">100</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<p>You MAY pass a <code>null</code> limit in order to put no limit on the number of
open connections and keep accepting new connection until you run out of
operating system resources (such as open file handles). This may be
useful if you do not want to take care of applying a limit but still want
to use the <code>getConnections()</code> method.</p>
<p>You can optionally configure the server to pause accepting new
connections once the connection limit is reached. In this case, it will
pause the underlying server and no longer process any new connections at
all, thus also no longer closing any excessive connections.
The underlying operating system is responsible for keeping a backlog of
pending connections until its limit is reached, at which point it will
start rejecting further connections.
Once the server is below the connection limit, it will continue consuming
connections from the backlog and will process any outstanding data on
each connection.
This mode may be useful for some protocols that are designed to wait for
a response message (such as HTTP), but may be less useful for other
protocols that demand immediate responses (such as a "welcome" message in
an interactive chat).</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>server</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">LimitingServer</span>(<span class="pl-s1"><span class="pl-c1">$</span>server</span>, <span class="pl-c1">100</span>, <span class="pl-c1">true</span>);
<span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">on</span>(<span class="pl-s">'<span class="pl-s">connection</span>'</span>, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">hello there!</span>'</span> . <span class="pl-c1">PHP_EOL</span>);
…
});</pre></div>
<div class="markdown-heading"><h5 class="heading-element">getConnections()</h5><a id="getconnections" class="anchor" aria-label="Permalink: getConnections()" href="#getconnections"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>getConnections(): ConnectionInterface[]</code> method can be used to
return an array with all currently active connections.</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-k">foreach</span> (<span class="pl-s1"><span class="pl-c1">$</span>server</span>-><span class="pl-en">getConnection</span>() <span class="pl-k">as</span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">Hi!</span>'</span>);
}</pre></div>
<div class="markdown-heading"><h2 class="heading-element">Client usage</h2><a id="client-usage" class="anchor" aria-label="Permalink: Client usage" href="#client-usage"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<div class="markdown-heading"><h3 class="heading-element">ConnectorInterface</h3><a id="connectorinterface" class="anchor" aria-label="Permalink: ConnectorInterface" href="#connectorinterface"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>ConnectorInterface</code> is responsible for providing an interface for
establishing streaming connections, such as a normal TCP/IP connection.</p>
<p>This is the main interface defined in this package and it is used throughout
React's vast ecosystem.</p>
<p>Most higher-level components (such as HTTP, database or other networking
service clients) accept an instance implementing this interface to create their
TCP/IP connection to the underlying networking service.
This is usually done via dependency injection, so it's fairly simple to actually
swap this implementation against any other implementation of this interface.</p>
<p>The interface only offers a single method:</p>
<div class="markdown-heading"><h4 class="heading-element">connect()</h4><a id="connect" class="anchor" aria-label="Permalink: connect()" href="#connect"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>connect(string $uri): PromiseInterface<ConnectionInterface></code> method can be used to
create a streaming connection to the given remote address.</p>
<p>It returns a <a href="../promise/">Promise</a> which either
fulfills with a stream implementing <a href="#connectioninterface"><code>ConnectionInterface</code></a>
on success or rejects with an <code>Exception</code> if the connection is not successful:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">google.com:443</span>'</span>)-><span class="pl-en">then</span>(
<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-c">// connection successfully established</span>
},
<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>error</span>) {
<span class="pl-c">// failed to connect due to $error</span>
}
);</pre></div>
<p>See also <a href="#connectioninterface"><code>ConnectionInterface</code></a> for more details.</p>
<p>The returned Promise MUST be implemented in such a way that it can be
cancelled when it is still pending. Cancelling a pending promise MUST
reject its value with an <code>Exception</code>. It SHOULD clean up any underlying
resources and references as applicable:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>promise</span> = <span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s1"><span class="pl-c1">$</span>uri</span>);
<span class="pl-s1"><span class="pl-c1">$</span>promise</span>-><span class="pl-en">cancel</span>();</pre></div>
<div class="markdown-heading"><h3 class="heading-element">Connector</h3><a id="connector" class="anchor" aria-label="Permalink: Connector" href="#connector"><span aria-hidden="true" class="octicon octicon-link"></span></a></div>
<p>The <code>Connector</code> class is the main class in this package that implements the
<a href="#connectorinterface"><code>ConnectorInterface</code></a> and allows you to create streaming connections.</p>
<p>You can use this connector to create any kind of streaming connections, such
as plaintext TCP/IP, secure TLS or local Unix connection streams.</p>
<p>It binds to the main event loop and can be used like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>();
<span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s1"><span class="pl-c1">$</span>uri</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
}, <span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-smi">Exception</span></span> <span class="pl-s1"><span class="pl-c1">$</span>e</span>) {
<span class="pl-k">echo</span> <span class="pl-s">'<span class="pl-s">Error: </span>'</span> . <span class="pl-s1"><span class="pl-c1">$</span>e</span>-><span class="pl-en">getMessage</span>() . <span class="pl-c1">PHP_EOL</span>;
});</pre></div>
<p>In order to create a plaintext TCP/IP connection, you can simply pass a host
and port combination like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">www.google.com:80</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<blockquote>
<p>If you do no specify a URI scheme in the destination URI, it will assume
<code>tcp://</code> as a default and establish a plaintext TCP/IP connection.
Note that TCP/IP connections require a host and port part in the destination
URI like above, all other URI components are optional.</p>
</blockquote>
<p>In order to create a secure TLS connection, you can use the <code>tls://</code> URI scheme
like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">tls://www.google.com:443</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<p>In order to create a local Unix domain socket connection, you can use the
<code>unix://</code> URI scheme like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">unix:///tmp/demo.sock</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<blockquote>
<p>The <a href="#getremoteaddress"><code>getRemoteAddress()</code></a> method will return the target
Unix domain socket (UDS) path as given to the <code>connect()</code> method, including
the <code>unix://</code> scheme, for example <code>unix:///tmp/demo.sock</code>.
The <a href="#getlocaladdress"><code>getLocalAddress()</code></a> method will most likely return a
<code>null</code> value as this value is not applicable to UDS connections here.</p>
</blockquote>
<p>Under the hood, the <code>Connector</code> is implemented as a <em>higher-level facade</em>
for the lower-level connectors implemented in this package. This means it
also shares all of their features and implementation details.
If you want to typehint in your higher-level protocol implementation, you SHOULD
use the generic <a href="#connectorinterface"><code>ConnectorInterface</code></a> instead.</p>
<p>As of <code>v1.4.0</code>, the <code>Connector</code> class defaults to using the
<a href="https://en.wikipedia.org/wiki/Happy_Eyeballs" rel="nofollow">happy eyeballs algorithm</a> to
automatically connect over IPv4 or IPv6 when a hostname is given.
This automatically attempts to connect using both IPv4 and IPv6 at the same time
(preferring IPv6), thus avoiding the usual problems faced by users with imperfect
IPv6 connections or setups.
If you want to revert to the old behavior of only doing an IPv4 lookup and
only attempt a single IPv4 connection, you can set up the <code>Connector</code> like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">happy_eyeballs</span>'</span> => <span class="pl-c1">false</span>
));</pre></div>
<p>Similarly, you can also affect the default DNS behavior as follows.
The <code>Connector</code> class will try to detect your system DNS settings (and uses
Google's public DNS server <code>8.8.8.8</code> as a fallback if unable to determine your
system settings) to resolve all public hostnames into underlying IP addresses by
default.
If you explicitly want to use a custom DNS server (such as a local DNS relay or
a company wide DNS server), you can set up the <code>Connector</code> like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">dns</span>'</span> => <span class="pl-s">'<span class="pl-s">127.0.1.1</span>'</span>
));
<span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">localhost:80</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<p>If you do not want to use a DNS resolver at all and want to connect to IP
addresses only, you can also set up your <code>Connector</code> like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">dns</span>'</span> => <span class="pl-c1">false</span>
));
<span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">127.0.0.1:80</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<p>Advanced: If you need a custom DNS <code>React\Dns\Resolver\ResolverInterface</code> instance, you
can also set up your <code>Connector</code> like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>dnsResolverFactory</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Dns</span>\<span class="pl-v">Resolver</span>\<span class="pl-v">Factory</span>();
<span class="pl-s1"><span class="pl-c1">$</span>resolver</span> = <span class="pl-s1"><span class="pl-c1">$</span>dnsResolverFactory</span>-><span class="pl-en">createCached</span>(<span class="pl-s">'<span class="pl-s">127.0.1.1</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">dns</span>'</span> => <span class="pl-s1"><span class="pl-c1">$</span>resolver</span>
));
<span class="pl-s1"><span class="pl-c1">$</span>connector</span>-><span class="pl-en">connect</span>(<span class="pl-s">'<span class="pl-s">localhost:80</span>'</span>)-><span class="pl-en">then</span>(<span class="pl-k">function</span> (<span class="pl-smi"><span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-smi">ConnectionInterface</span></span> <span class="pl-s1"><span class="pl-c1">$</span>connection</span>) {
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">write</span>(<span class="pl-s">'<span class="pl-s">...</span>'</span>);
<span class="pl-s1"><span class="pl-c1">$</span>connection</span>-><span class="pl-en">end</span>();
});</pre></div>
<p>By default, the <code>tcp://</code> and <code>tls://</code> URI schemes will use timeout value that
respects your <code>default_socket_timeout</code> ini setting (which defaults to 60s).
If you want a custom timeout value, you can simply pass this like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">timeout</span>'</span> => <span class="pl-c1">10.0</span>
));</pre></div>
<p>Similarly, if you do not want to apply a timeout at all and let the operating
system handle this, you can pass a boolean flag like this:</p>
<div class="highlight highlight-text-html-php"><pre><span class="pl-s1"><span class="pl-c1">$</span>connector</span> = <span class="pl-k">new</span> <span class="pl-v">React</span>\<span class="pl-v">Socket</span>\<span class="pl-v">Connector</span>(<span class="pl-en">array</span>(
<span class="pl-s">'<span class="pl-s">timeout</span>'</span> => <span class="pl-c1">false</span>