forked from rcaputo/poe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SocketFactory.pm
1601 lines (1316 loc) · 47.7 KB
/
SocketFactory.pm
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
package POE::Wheel::SocketFactory;
use strict;
use vars qw($VERSION);
$VERSION = '1.266'; # NOTE - Should be #.### (three decimal places)
use Carp qw( carp croak );
use Symbol qw( gensym );
use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
use Errno qw(EWOULDBLOCK EADDRNOTAVAIL EINPROGRESS EADDRINUSE);
use Socket qw(
AF_INET SOCK_STREAM SOL_SOCKET AF_UNIX PF_UNIX
PF_INET SOCK_DGRAM SO_ERROR unpack_sockaddr_in
unpack_sockaddr_un PF_UNSPEC SO_REUSEADDR INADDR_ANY
pack_sockaddr_in pack_sockaddr_un inet_aton SOMAXCONN
);
use IO::Handle ();
use FileHandle ();
use POE qw( Wheel );
sub CRIMSON_SCOPE_HACK ($) { 0 }
sub DEBUG () { 0 }
sub MY_SOCKET_HANDLE () { 0 }
sub MY_UNIQUE_ID () { 1 }
sub MY_EVENT_SUCCESS () { 2 }
sub MY_EVENT_FAILURE () { 3 }
sub MY_SOCKET_DOMAIN () { 4 }
sub MY_STATE_ACCEPT () { 5 }
sub MY_STATE_CONNECT () { 6 }
sub MY_MINE_SUCCESS () { 7 }
sub MY_MINE_FAILURE () { 8 }
sub MY_SOCKET_PROTOCOL () { 9 }
sub MY_SOCKET_TYPE () { 10 }
sub MY_STATE_ERROR () { 11 }
sub MY_SOCKET_SELECTED () { 12 }
# Fletch has subclassed SSLSocketFactory from SocketFactory. He's
# added new members after MY_SOCKET_SELECTED. Be sure, if you extend
# this, to extend add stuff BEFORE MY_SOCKET_SELECTED or let Fletch
# know you've broken his module.
# Provide dummy constants for systems that don't have them.
# Test and provide for each constant separately, per suggestion in
# rt.cpan.org 27250.
BEGIN {
eval { require Socket6 };
if ($@) {
*Socket6::AF_INET6 = sub () { ~0 };
*Socket6::PF_INET6 = sub () { ~0 };
}
else {
eval { my $x = &Socket6::AF_INET6 };
*Socket6::AF_INET6 = sub () { ~0 } if $@;
eval { my $x = &Socket6::PF_INET6 };
*Socket6::PF_INET6 = sub () { ~0 } if $@;
}
}
#------------------------------------------------------------------------------
# These tables customize the socketfactory. Many protocols share the
# same operations, it seems, and this is a way to add new ones with a
# minimum of additional code.
sub DOM_UNIX () { 'unix' } # UNIX domain socket
sub DOM_INET () { 'inet' } # INET domain socket
sub DOM_INET6 () { 'inet6' } # INET v6 domain socket
# AF_XYZ and PF_XYZ may be different.
my %map_family_to_domain = (
AF_UNIX, DOM_UNIX, PF_UNIX, DOM_UNIX,
AF_INET, DOM_INET, PF_INET, DOM_INET,
&Socket6::AF_INET6, DOM_INET6,
&Socket6::PF_INET6, DOM_INET6,
);
sub SVROP_LISTENS () { 'listens' } # connect/listen sockets
sub SVROP_NOTHING () { 'nothing' } # connectionless sockets
# Map family/protocol pairs to connection or connectionless
# operations.
my %supported_protocol = (
DOM_UNIX, {
none => SVROP_LISTENS
},
DOM_INET, {
tcp => SVROP_LISTENS,
udp => SVROP_NOTHING,
},
DOM_INET6, {
tcp => SVROP_LISTENS,
udp => SVROP_NOTHING,
},
);
# Sane default socket types for each supported protocol. TODO Maybe
# this structure can be combined with %supported_protocol?
my %default_socket_type = (
DOM_UNIX, {
none => SOCK_STREAM
},
DOM_INET, {
tcp => SOCK_STREAM,
udp => SOCK_DGRAM,
},
DOM_INET6, {
tcp => SOCK_STREAM,
udp => SOCK_DGRAM,
},
);
#------------------------------------------------------------------------------
# Perform system-dependent translations on Unix addresses, if
# necessary.
sub _condition_unix_address {
my ($address) = @_;
# OS/2 would like sockets to use backwhacks, and please place them
# in the virtual \socket\ directory. Thank you.
if ($^O eq 'os2') {
$address =~ tr[\\][/];
if ($address !~ m{^/socket/}) {
$address =~ s{^/?}{/socket/};
}
$address =~ tr[/][\\];
}
$address;
}
#------------------------------------------------------------------------------
# Define the select handler that will accept connections.
sub _define_accept_state {
my $self = shift;
# We do these stupid closure tricks to avoid putting $self in it
# directly. If you include $self in one of the state() closures,
# the component will fail to shut down properly: there will be a
# circular definition in the closure holding $self alive.
my $domain = $map_family_to_domain{ $self->[MY_SOCKET_DOMAIN] };
$domain = '(undef)' unless defined $domain;
my $event_success = \$self->[MY_EVENT_SUCCESS];
my $event_failure = \$self->[MY_EVENT_FAILURE];
my $unique_id = $self->[MY_UNIQUE_ID];
$poe_kernel->state(
$self->[MY_STATE_ACCEPT] = ref($self) . "($unique_id) -> select accept",
sub {
# prevents SEGV
0 && CRIMSON_SCOPE_HACK('<');
# subroutine starts here
my ($k, $me, $handle) = @_[KERNEL, SESSION, ARG0];
my $new_socket = gensym;
my $peer = accept($new_socket, $handle);
if ($peer) {
my ($peer_addr, $peer_port);
if ( $domain eq DOM_UNIX ) {
$peer_addr = $peer_port = undef;
}
elsif ( $domain eq DOM_INET ) {
($peer_port, $peer_addr) = unpack_sockaddr_in($peer);
}
elsif ( $domain eq DOM_INET6 ) {
$peer = getpeername($new_socket);
($peer_port, $peer_addr) = Socket6::unpack_sockaddr_in6($peer);
}
else {
die "sanity failure: socket domain == $domain";
}
$k->call(
$me, $$event_success,
$new_socket, $peer_addr, $peer_port,
$unique_id
);
}
elsif ($! != EWOULDBLOCK) {
$$event_failure && $k->call(
$me, $$event_failure,
'accept', ($!+0), $!, $unique_id
);
}
}
);
$self->[MY_SOCKET_SELECTED] = 'yes';
$poe_kernel->select_read(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_ACCEPT]
);
}
#------------------------------------------------------------------------------
# Define the select handler that will finalize an established
# connection.
sub _define_connect_state {
my $self = shift;
# We do these stupid closure tricks to avoid putting $self in it
# directly. If you include $self in one of the state() closures,
# the component will fail to shut down properly: there will be a
# circular definition in the closure holding $self alive.
my $domain = $map_family_to_domain{ $self->[MY_SOCKET_DOMAIN] };
$domain = '(undef)' unless defined $domain;
my $event_success = \$self->[MY_EVENT_SUCCESS];
my $event_failure = \$self->[MY_EVENT_FAILURE];
my $unique_id = $self->[MY_UNIQUE_ID];
my $socket_selected = \$self->[MY_SOCKET_SELECTED];
my $socket_handle = \$self->[MY_SOCKET_HANDLE];
my $state_accept = \$self->[MY_STATE_ACCEPT];
my $state_connect = \$self->[MY_STATE_CONNECT];
my $mine_success = \$self->[MY_MINE_SUCCESS];
my $mine_failure = \$self->[MY_MINE_FAILURE];
$poe_kernel->state(
$self->[MY_STATE_CONNECT] = (
ref($self) . "($unique_id) -> select connect"
),
sub {
# This prevents SEGV in older versions of Perl.
0 && CRIMSON_SCOPE_HACK('<');
# Grab some values and stop watching the socket.
my ($k, $me, $handle) = @_[KERNEL, SESSION, ARG0];
_shutdown(
$socket_selected, $socket_handle,
$state_accept, $state_connect,
$mine_success, $event_success,
$mine_failure, $event_failure,
);
# Throw a failure if the connection failed.
$! = unpack('i', getsockopt($handle, SOL_SOCKET, SO_ERROR));
if ($!) {
(defined $$event_failure) and $k->call(
$me, $$event_failure,
'connect', ($!+0), $!, $unique_id
);
return;
}
# Get the remote address, or throw an error if that fails.
my $peer = getpeername($handle);
if ($!) {
(defined $$event_failure) and $k->call(
$me, $$event_failure,
'getpeername', ($!+0), $!, $unique_id
);
return;
}
# Parse the remote address according to the socket's domain.
my ($peer_addr, $peer_port);
# UNIX sockets have some trouble with peer addresses.
if ($domain eq DOM_UNIX) {
if (defined $peer) {
eval {
$peer_addr = unpack_sockaddr_un($peer);
};
undef $peer_addr if length $@;
}
}
# INET socket stacks tend not to.
elsif ($domain eq DOM_INET) {
if (defined $peer) {
eval {
($peer_port, $peer_addr) = unpack_sockaddr_in($peer);
};
if (length $@) {
$peer_port = $peer_addr = undef;
}
}
}
# INET6 socket stacks tend not to.
elsif ($domain eq DOM_INET6) {
if (defined $peer) {
eval {
($peer_port, $peer_addr) = Socket6::unpack_sockaddr_in6($peer);
};
if (length $@) {
$peer_port = $peer_addr = undef;
}
}
}
# What are we doing here?
else {
die "sanity failure: socket domain == $domain";
}
# Tell the session it went okay. Also let go of the socket.
$k->call(
$me, $$event_success,
$handle, $peer_addr, $peer_port, $unique_id
);
}
);
# Cygwin expects an error state registered to expedite. This code
# is nearly identical the stuff above.
if ($^O eq "cygwin") {
$poe_kernel->state(
$self->[MY_STATE_ERROR] = (
ref($self) . "($unique_id) -> connect error"
),
sub {
# This prevents SEGV in older versions of Perl.
0 && CRIMSON_SCOPE_HACK('<');
# Grab some values and stop watching the socket.
my ($k, $me, $handle) = @_[KERNEL, SESSION, ARG0];
_shutdown(
$socket_selected, $socket_handle,
$state_accept, $state_connect,
$mine_success, $event_success,
$mine_failure, $event_failure,
);
# Throw a failure if the connection failed.
$! = unpack('i', getsockopt($handle, SOL_SOCKET, SO_ERROR));
if ($!) {
(defined $$event_failure) and $k->call(
$me, $$event_failure, 'connect', ($!+0), $!, $unique_id
);
return;
}
}
);
$poe_kernel->select_expedite(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_ERROR]
);
}
$self->[MY_SOCKET_SELECTED] = 'yes';
$poe_kernel->select_write(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_CONNECT]
);
}
#------------------------------------------------------------------------------
sub event {
my $self = shift;
push(@_, undef) if (scalar(@_) & 1);
while (@_) {
my ($name, $event) = splice(@_, 0, 2);
if ($name eq 'SuccessEvent') {
if (defined $event) {
if (ref($event)) {
carp "reference for SuccessEvent will be treated as an event name"
}
$self->[MY_EVENT_SUCCESS] = $event;
undef $self->[MY_MINE_SUCCESS];
}
else {
carp "SuccessEvent requires an event name. ignoring undef";
}
}
elsif ($name eq 'FailureEvent') {
if (defined $event) {
if (ref($event)) {
carp "reference for FailureEvent will be treated as an event name";
}
$self->[MY_EVENT_FAILURE] = $event;
undef $self->[MY_MINE_FAILURE];
}
else {
carp "FailureEvent requires an event name. ignoring undef";
}
}
else {
carp "ignoring unknown SocketFactory parameter '$name'";
}
}
$self->[MY_SOCKET_SELECTED] = 'yes';
if (defined $self->[MY_STATE_ACCEPT]) {
$poe_kernel->select_read(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_ACCEPT]
);
}
elsif (defined $self->[MY_STATE_CONNECT]) {
$poe_kernel->select_write(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_CONNECT]
);
if ($^O eq "cygwin") {
$poe_kernel->select_expedite(
$self->[MY_SOCKET_HANDLE],
$self->[MY_STATE_ERROR]
);
}
}
else {
die "POE developer error - no state defined";
}
}
#------------------------------------------------------------------------------
sub getsockname {
my $self = shift;
return undef unless defined $self->[MY_SOCKET_HANDLE];
return getsockname($self->[MY_SOCKET_HANDLE]);
}
sub ID {
return $_[0]->[MY_UNIQUE_ID];
}
#------------------------------------------------------------------------------
sub new {
my $type = shift;
# Don't take responsibility for a bad parameter count.
croak "$type requires an even number of parameters" if @_ & 1;
my %params = @_;
# The calling convention experienced a hard deprecation.
croak "wheels no longer require a kernel reference as their first parameter"
if (@_ && (ref($_[0]) eq 'POE::Kernel'));
# Ensure some of the basic things are present.
croak "$type requires a working Kernel" unless (defined $poe_kernel);
croak 'SuccessEvent required' unless (defined $params{SuccessEvent});
croak 'FailureEvent required' unless (defined $params{FailureEvent});
my $event_success = $params{SuccessEvent};
my $event_failure = $params{FailureEvent};
# Create the SocketServer. Cache a copy of the socket handle.
my $socket_handle = gensym();
my $self = bless(
[
$socket_handle, # MY_SOCKET_HANDLE
&POE::Wheel::allocate_wheel_id(), # MY_UNIQUE_ID
$event_success, # MY_EVENT_SUCCESS
$event_failure, # MY_EVENT_FAILURE
undef, # MY_SOCKET_DOMAIN
undef, # MY_STATE_ACCEPT
undef, # MY_STATE_CONNECT
undef, # MY_MINE_SUCCESS
undef, # MY_MINE_FAILURE
undef, # MY_SOCKET_PROTOCOL
undef, # MY_SOCKET_TYPE
undef, # MY_STATE_ERROR
undef, # MY_SOCKET_SELECTED
],
$type
);
# Default to Internet sockets.
my $domain = delete $params{SocketDomain};
$domain = AF_INET unless defined $domain;
$self->[MY_SOCKET_DOMAIN] = $domain;
# Abstract the socket domain into something we don't have to keep
# testing duplicates of.
my $abstract_domain = $map_family_to_domain{$self->[MY_SOCKET_DOMAIN]};
unless (defined $abstract_domain) {
$poe_kernel->yield(
$event_failure, 'domain', 0, '', $self->[MY_UNIQUE_ID]
);
return $self;
}
#---------------#
# Create Socket #
#---------------#
# Declare the protocol name out here; it'll be needed by
# getservbyname later.
my $protocol_name;
# Unix sockets don't use protocols; warn the programmer, and force
# PF_UNSPEC.
if ($abstract_domain eq DOM_UNIX) {
carp 'SocketProtocol ignored for Unix socket'
if defined $params{SocketProtocol};
$self->[MY_SOCKET_PROTOCOL] = PF_UNSPEC;
$protocol_name = 'none';
}
# Internet sockets use protocols. Default the INET protocol to tcp,
# and try to resolve it.
elsif (
$abstract_domain eq DOM_INET or
$abstract_domain eq DOM_INET6
) {
my $socket_protocol = (
(defined $params{SocketProtocol})
? $params{SocketProtocol}
: 'tcp'
);
if ($socket_protocol !~ /^\d+$/) {
unless ($socket_protocol = getprotobyname($socket_protocol)) {
$poe_kernel->yield(
$event_failure, 'getprotobyname', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
# Get the protocol's name regardless of what was provided. If the
# protocol isn't supported, croak now instead of making the
# programmer wonder why things fail later.
$protocol_name = lc(getprotobynumber($socket_protocol));
unless ($protocol_name) {
$poe_kernel->yield(
$event_failure, 'getprotobynumber', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
unless (defined $supported_protocol{$abstract_domain}->{$protocol_name}) {
croak "SocketFactory does not support Internet $protocol_name sockets";
}
$self->[MY_SOCKET_PROTOCOL] = $socket_protocol;
}
else {
die "Mail this error to the author of POE: Internal consistency error";
}
# If no SocketType, default it to something appropriate.
if (defined $params{SocketType}) {
$self->[MY_SOCKET_TYPE] = $params{SocketType};
}
else {
unless (defined $default_socket_type{$abstract_domain}->{$protocol_name}) {
croak "SocketFactory does not support $abstract_domain $protocol_name";
}
$self->[MY_SOCKET_TYPE] =
$default_socket_type{$abstract_domain}->{$protocol_name};
}
# o create a dummy socket
# o cache the value of SO_OPENTYPE in $win32_socket_opt
# o set the overlapped io attribute
# o close dummy socket
my $win32_socket_opt;
if ( POE::Kernel::RUNNING_IN_HELL) {
# Constants are evaluated first so they exist when the code uses
# them.
eval {
*SO_OPENTYPE = sub () { 0x7008 };
*SO_SYNCHRONOUS_ALERT = sub () { 0x10 };
*SO_SYNCHRONOUS_NONALERT = sub () { 0x20 };
};
die "Could not install SO constants [$@]" if $@;
# Turn on socket overlapped IO attribute per MSKB: Q181611.
eval {
socket(POE, AF_INET, SOCK_STREAM, getprotobyname("tcp"))
or die "socket failed: $!";
my $opt = unpack("I", getsockopt(POE, SOL_SOCKET, SO_OPENTYPE()));
$win32_socket_opt = $opt;
$opt &= ~(SO_SYNCHRONOUS_ALERT()|SO_SYNCHRONOUS_NONALERT());
setsockopt(POE, SOL_SOCKET, SO_OPENTYPE(), $opt);
close POE;
};
die if $@;
}
# Create the socket.
unless (
socket( $socket_handle, $self->[MY_SOCKET_DOMAIN],
$self->[MY_SOCKET_TYPE], $self->[MY_SOCKET_PROTOCOL]
)
) {
$poe_kernel->yield(
$event_failure, 'socket', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
# o create a dummy socket
# o restore previous value of SO_OPENTYPE
# o close dummy socket
#
# This way we'd only be turning on the overlap attribute for
# the socket we created... and not all subsequent sockets.
if ( POE::Kernel::RUNNING_IN_HELL) {
eval {
socket(POE, AF_INET, SOCK_STREAM, getprotobyname("tcp"))
or die "socket failed: $!";
setsockopt(POE, SOL_SOCKET, SO_OPENTYPE(), $win32_socket_opt);
close POE;
};
die if $@;
}
DEBUG && warn "socket";
#------------------#
# Configure Socket #
#------------------#
# Make the socket binary. It's wrapped in eval{} because tied
# filehandle classes may actually die in their binmode methods.
eval { binmode($socket_handle) };
# Don't block on socket operations, because the socket will be
# driven by a select loop.
# RCC 2002-12-19: Replace the complex blocking checks and methods
# with IO::Handle's blocking(0) method. This is theoretically more
# portable and less maintenance than rolling our own. If things
# work out, we'll remove the commented out code.
# RCC 2003-01-20: Unfortunately, blocking() isn't available in perl
# 5.005_03, and people still use that. We'll use blocking() for
# Perl 5.8.0 and beyond, since that's the first version of
# ActivePerl that has a problem.
if ($] >= 5.008) {
$socket_handle->blocking(0);
}
else {
# Do it the Win32 way. XXX This is incomplete.
if ($^O eq 'MSWin32') {
my $set_it = "1";
# 126 is FIONBIO (some docs say 0x7F << 16)
ioctl(
$socket_handle,
0x80000000 | (4 << 16) | (ord('f') << 8) | 126,
\$set_it
) or do {
$poe_kernel->yield(
$event_failure,
'ioctl', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
};
}
# Do it the way everyone else does.
else {
my $flags = fcntl($socket_handle, F_GETFL, 0) or do {
$poe_kernel->yield(
$event_failure,
'fcntl', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
};
$flags = fcntl($socket_handle, F_SETFL, $flags | O_NONBLOCK) or do {
$poe_kernel->yield(
$event_failure,
'fcntl', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
};
}
}
# Make the socket reusable, if requested.
if (
(defined $params{Reuse})
and ( (lc($params{Reuse}) eq 'yes')
or (lc($params{Reuse}) eq 'on')
or ( ($params{Reuse} =~ /\d+/)
and $params{Reuse}
)
)
)
{
setsockopt($socket_handle, SOL_SOCKET, SO_REUSEADDR, 1) or do {
$poe_kernel->yield(
$event_failure,
'setsockopt', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
};
}
#-------------#
# Bind Socket #
#-------------#
my $bind_address;
# Check SocketFactory /Bind.*/ parameters in an Internet socket
# context, and translate them into parameters that bind()
# understands.
if ($abstract_domain eq DOM_INET) {
# Don't bind if the creator doesn't specify a related parameter.
if ((defined $params{BindAddress}) or (defined $params{BindPort})) {
# Set the bind address, or default to INADDR_ANY.
$bind_address = (
(defined $params{BindAddress})
? $params{BindAddress}
: INADDR_ANY
);
# Need to check lengths in octets, not characters.
BEGIN { eval { require bytes } and bytes->import; }
# Resolve the bind address if it's not already packed.
unless (length($bind_address) == 4) {
$bind_address = inet_aton($bind_address);
}
unless (defined $bind_address) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
"inet_aton", $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
# Set the bind port, or default to 0 (any) if none specified.
# Resolve it to a number, if at all possible.
my $bind_port = (defined $params{BindPort}) ? $params{BindPort} : 0;
if ($bind_port =~ /[^0-9]/) {
$bind_port = getservbyname($bind_port, $protocol_name);
unless (defined $bind_port) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
'getservbyname', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
$bind_address = pack_sockaddr_in($bind_port, $bind_address);
unless (defined $bind_address) {
$poe_kernel->yield(
$event_failure,
"pack_sockaddr_in", $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
}
# Check SocketFactory /Bind.*/ parameters in an Internet socket
# context, and translate them into parameters that bind()
# understands.
elsif ($abstract_domain eq DOM_INET6) {
# Don't bind if the creator doesn't specify a related parameter.
if ((defined $params{BindAddress}) or (defined $params{BindPort})) {
# Set the bind address, or default to INADDR_ANY.
$bind_address = (
(defined $params{BindAddress})
? $params{BindAddress}
: Socket6::in6addr_any()
);
# Set the bind port, or default to 0 (any) if none specified.
# Resolve it to a number, if at all possible.
my $bind_port = (defined $params{BindPort}) ? $params{BindPort} : 0;
if ($bind_port =~ /[^0-9]/) {
$bind_port = getservbyname($bind_port, $protocol_name);
unless (defined $bind_port) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
'getservbyname', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
# Need to check lengths in octets, not characters.
BEGIN { eval { require bytes } and bytes->import; }
# Resolve the bind address.
my @info = Socket6::getaddrinfo(
$bind_address, $bind_port,
$self->[MY_SOCKET_DOMAIN], $self->[MY_SOCKET_TYPE],
);
if (@info < 5) { # unless defined $bind_address
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
"getaddrinfo", $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
$bind_address = $info[3];
}
}
# Check SocketFactory /Bind.*/ parameters in a Unix context, and
# translate them into parameters bind() understands.
elsif ($abstract_domain eq DOM_UNIX) {
carp 'BindPort ignored for Unix socket' if defined $params{BindPort};
if (defined $params{BindAddress}) {
# Is this necessary, or will bind() return EADDRINUSE?
if (defined $params{RemotePort}) {
$! = EADDRINUSE;
$poe_kernel->yield(
$event_failure,
'bind', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
$bind_address = &_condition_unix_address($params{BindAddress});
$bind_address = pack_sockaddr_un($bind_address);
unless ($bind_address) {
$poe_kernel->yield(
$event_failure,
'pack_sockaddr_un', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
}
# This is an internal consistency error, and it should be hard
# trapped right away.
else {
die "Mail this error to the author of POE: Internal consistency error";
}
# Perform the actual bind, if there's a bind address to bind to.
if (defined $bind_address) {
unless (bind($socket_handle, $bind_address)) {
$poe_kernel->yield(
$event_failure,
'bind', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
DEBUG && warn "bind";
}
#---------#
# Connect #
#---------#
my $connect_address;
if (defined $params{RemoteAddress}) {
# Check SocketFactory /Remote.*/ parameters in an Internet socket
# context, and translate them into parameters that connect()
# understands.
if (
$abstract_domain eq DOM_INET or
$abstract_domain eq DOM_INET6
) {
# connecting if RemoteAddress
croak 'RemotePort required' unless (defined $params{RemotePort});
carp 'ListenQueue ignored' if (defined $params{ListenQueue});
my $remote_port = $params{RemotePort};
if ($remote_port =~ /[^0-9]/) {
unless ($remote_port = getservbyname($remote_port, $protocol_name)) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
'getservbyname', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
my $error_tag;
if ($abstract_domain eq DOM_INET) {
$connect_address = inet_aton($params{RemoteAddress});
$error_tag = "inet_aton";
}
elsif ($abstract_domain eq DOM_INET6) {
my @info = Socket6::getaddrinfo(
$params{RemoteAddress}, $remote_port,
$self->[MY_SOCKET_DOMAIN], $self->[MY_SOCKET_TYPE],
);
if (@info < 5) {
$connect_address = undef;
}
else {
$connect_address = $info[3];
}
$error_tag = "getaddrinfo";
}
else {
die "unknown domain $abstract_domain";
}
# TODO - If the gethostbyname2() code is removed, then we can
# combine the previous code with the following code, and perhaps
# remove one of these redundant $connect_address checks. The
# 0.29 release should tell us pretty quickly whether it's
# needed. If we reach 0.30 without incident, it's probably safe
# to remove the old gethostbyname2() code and clean this up.
unless (defined $connect_address) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
$error_tag, $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
if ($abstract_domain eq DOM_INET) {
$connect_address = pack_sockaddr_in($remote_port, $connect_address);
$error_tag = "pack_sockaddr_in";
}
elsif ($abstract_domain eq DOM_INET6) {
$error_tag = "pack_sockaddr_in6";
}
else {
die "unknown domain $abstract_domain";
}
unless ($connect_address) {
$! = EADDRNOTAVAIL;
$poe_kernel->yield(
$event_failure,
$error_tag, $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
# Check SocketFactory /Remote.*/ parameters in a Unix socket
# context, and translate them into parameters connect()
# understands.
elsif ($abstract_domain eq DOM_UNIX) {
$connect_address = _condition_unix_address($params{RemoteAddress});
$connect_address = pack_sockaddr_un($connect_address);
unless (defined $connect_address) {
$poe_kernel->yield(
$event_failure,
'pack_sockaddr_un', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
# This is an internal consistency error, and it should be trapped
# right away.
else {
die "Mail this error to the author of POE: Internal consistency error";
}
}
else {
carp "RemotePort ignored without RemoteAddress"
if defined $params{RemotePort};
}
# Perform the actual connection, if a connection was requested. If
# the connection can be established, then return the SocketFactory
# handle.
if (defined $connect_address) {
unless (connect($socket_handle, $connect_address)) {
if ($! and ($! != EINPROGRESS) and ($! != EWOULDBLOCK)) {
$poe_kernel->yield(
$event_failure,
'connect', $!+0, $!, $self->[MY_UNIQUE_ID]
);
return $self;
}
}
DEBUG && warn "connect";
$self->[MY_SOCKET_HANDLE] = $socket_handle;