2 # This has been taken from the 'Advanced Perl Programming' book by Sriram Srinivasan
4 # I am presuming that the code is distributed on the same basis as perl itself.
6 # I have modified it to suit my devious purposes (Dirk Koopman G1TLH)
21 use vars qw(%rd_callbacks %wt_callbacks %er_callbacks $rd_handles $wt_handles $er_handles $now %conns $noconns $blocking_supported $cnum $total_in $total_out $io_socket);
26 $rd_handles = IO::Select->new();
27 $wt_handles = IO::Select->new();
28 $er_handles = IO::Select->new();
29 $total_in = $total_out = 0;
34 # Checks if blocking is supported
37 require POSIX; POSIX->import(qw(O_NONBLOCK F_SETFL F_GETFL))
42 require IO::Socket::INET6;
48 $io_socket = 'IO::Socket::INET';
50 $io_socket = 'IO::Socket::INET6';
54 if ($@ || $main::is_win) {
55 $blocking_supported = $io_socket->can('blocking') ? 2 : 0;
57 $blocking_supported = $io_socket->can('blocking') ? 2 : 1;
61 # import as many of these errno values as are available
64 require Errno; Errno->import(qw(EAGAIN EINPROGRESS EWOULDBLOCK));
67 unless ($^O eq 'MSWin32') {
71 require Socket; Socket->import(qw(IPPROTO_TCP TCP_NODELAY));
74 dbg("IPPROTO_TCP and TCP_NODELAY manually defined");
75 eval 'sub IPPROTO_TCP { 6 };';
76 eval 'sub TCP_NODELAY { 1 };';
79 # http://support.microsoft.com/support/kb/articles/Q150/5/37.asp
80 # defines EINPROGRESS as 10035. We provide it here because some
81 # Win32 users report POSIX::EINPROGRESS is not vendor-supported.
82 if ($^O eq 'MSWin32') {
83 eval '*EINPROGRESS = sub { 10036 };' unless defined *EINPROGRESS;
84 eval '*EWOULDBLOCK = *EAGAIN = sub { 10035 };' unless defined *EWOULDBLOCK;
85 eval '*F_GETFL = sub { 0 };';
86 eval '*F_SETFL = sub { 0 };';
87 eval '*IPPROTO_TCP = sub { 6 };';
88 eval '*TCP_NODELAY = sub { 1 };';
89 $blocking_supported = 0; # it appears that this DOESN'T work :-(
95 my $eagain = eval {EAGAIN()};
96 my $einprogress = eval {EINPROGRESS()};
97 my $ewouldblock = eval {EWOULDBLOCK()};
103 #-----------------------------------------------------------------
104 # Generalised initializer
108 my ($pkg, $rproc) = @_;
110 my $class = $obj || $pkg;
121 cnum => (($cnum < 999) ? (++$cnum) : ($cnum = 1)),
126 dbg("Connection created ($noconns)") if isdbg('connll');
127 return bless $conn, $class;
133 my $callback = shift;
134 $conn->{eproc} = $callback;
135 set_event_handler($conn->{sock}, error => $callback) if exists $conn->{sock};
141 my $callback = shift;
142 $conn->{rproc} = $callback;
147 return unless $blocking_supported;
149 # Make the handle stop blocking, the Windows way.
150 if ($blocking_supported) {
151 $_[0]->blocking($_[1]);
153 my $flags = fcntl ($_[0], F_GETFL, 0);
155 $flags &= ~O_NONBLOCK;
157 $flags |= O_NONBLOCK;
159 fcntl ($_[0], F_SETFL, $flags);
171 $call = $pkg->{call} unless $call;
172 return undef unless $call;
173 dbg("changing $pkg->{call} to $call") if isdbg('connll') && exists $pkg->{call} && $call ne $pkg->{call};
174 delete $conns{$pkg->{call}} if exists $pkg->{call} && exists $conns{$pkg->{call}} && $pkg->{call} ne $call;
175 $pkg->{call} = $call;
176 $ref = $conns{$call} = $pkg;
177 dbg("Connection $pkg->{cnum} $call stored") if isdbg('connll');
179 $ref = $conns{$call};
184 # this is only called by any dependent processes going away unexpectedly
187 my ($pkg, $pid) = @_;
189 my @pid = grep {$_->{pid} == $pid} values %conns;
190 foreach my $p (@pid) {
191 &{$p->{eproc}}($p, "$pid has gorn") if exists $p->{eproc};
196 #-----------------------------------------------------------------
199 my ($pkg, $to_host, $to_port, $rproc) = @_;
201 # Create a connection end-point object
204 $conn = $pkg->new($rproc);
206 $conn->{peerhost} = $to_host;
207 $conn->{peerport} = $to_port;
208 $conn->{sort} = 'Outgoing';
210 # Create a new internet socket
211 my $sock = $io_socket->new();
212 return undef unless $sock;
214 my $proto = getprotobyname('tcp');
215 $sock->socket(AF_INET, SOCK_STREAM, $proto) or return undef;
218 $conn->{blocking} = 0;
220 # does the host resolve?
221 my $ip = gethostbyname($to_host);
222 return undef unless $ip;
224 my $r = connect($sock, pack_sockaddr_in($to_port, $ip));
225 return undef unless $r || _err_will_block($!);
227 $conn->{sock} = $sock;
229 if ($conn->{rproc}) {
230 my $callback = sub {$conn->_rcv};
231 set_event_handler ($sock, read => $callback);
238 my ($conn, $line, $sort) = @_;
241 local $^F = 10000; # make sure it ain't closed on exec
242 my ($a, $b) = $io_socket->socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC);
251 $conn->{csort} = $sort;
252 $conn->{lineend} = "\cM" if $sort eq 'ax25';
254 if ($conn->{rproc}) {
255 my $callback = sub {$conn->_rcv};
256 Msg::set_event_handler ($a, read => $callback);
258 dbg("connect $conn->{cnum}: started pid: $conn->{pid} as $line") if isdbg('connect');
265 *STDIN = IO::File->new_from_fd($b, 'r') or die;
266 *STDOUT = IO::File->new_from_fd($b, 'w') or die;
267 *STDERR = IO::File->new_from_fd($b, 'w') or die;
269 unless ($main::is_win) {
270 # $SIG{HUP} = 'IGNORE';
271 $SIG{HUP} = $SIG{CHLD} = $SIG{TERM} = $SIG{INT} = 'DEFAULT';
274 exec "$line" or dbg("exec '$line' failed $!");
277 dbg("cannot fork for $line");
280 dbg("no socket pair $! for $line");
288 return if exists $conn->{disconnecting};
290 $conn->{disconnecting} = 1;
291 my $sock = delete $conn->{sock};
292 $conn->{state} = 'E';
293 $conn->{timeout}->del if $conn->{timeout};
295 # be careful to delete the correct one
297 if ($call = $conn->{call}) {
298 my $ref = $conns{$call};
299 delete $conns{$call} if $ref && $ref == $conn;
301 $call ||= 'unallocated';
302 dbg("Connection $conn->{cnum} $call disconnected") if isdbg('connll');
304 # get rid of any references
306 if (ref($conn->{$_})) {
311 if (defined($sock)) {
312 set_event_handler ($sock, read => undef, write => undef, error => undef);
317 unless ($main::is_win) {
318 kill 'TERM', $conn->{pid} if exists $conn->{pid};
323 my ($conn, $msg) = @_;
324 $conn->enqueue($msg);
325 $conn->_send (1); # 1 ==> flush
329 my ($conn, $msg) = @_;
330 $conn->enqueue($msg);
331 my $sock = $conn->{sock};
332 return unless defined($sock);
333 set_event_handler ($sock, write => sub {$conn->_send(0)});
338 push (@{$conn->{outqueue}}, defined $_[0] ? $_[0] : '');
342 my ($conn, $flush) = @_;
343 my $sock = $conn->{sock};
344 return unless defined($sock);
345 my $rq = $conn->{outqueue};
347 # If $flush is set, set the socket to blocking, and send all
348 # messages in the queue - return only if there's an error
349 # If $flush is 0 (deferred mode) make the socket non-blocking, and
350 # return to the event loop only after every message, or if it
351 # is likely to block in the middle of a message.
353 # if ($conn->{blocking} != $flush) {
354 # blocking($sock, $flush);
355 # $conn->{blocking} = $flush;
357 my $offset = (exists $conn->{send_offset}) ? $conn->{send_offset} : 0;
361 my $mlth = length($msg);
362 my $bytes_to_write = $mlth - $offset;
363 my $bytes_written = 0;
364 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
365 while ($bytes_to_write > 0) {
366 $bytes_written = syswrite ($sock, $msg,
367 $bytes_to_write, $offset);
368 if (!defined($bytes_written)) {
369 if (_err_will_block($!)) {
370 # Should happen only in deferred mode. Record how
371 # much we have already sent.
372 $conn->{send_offset} = $offset;
373 # Event handler should already be set, so we will
374 # be called back eventually, and will resume sending
377 &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
379 return 0; # fail. Message remains in queue ..
381 } elsif (isdbg('raw')) {
382 my $call = $conn->{call} || 'none';
383 dbgdump('raw', "$call send $bytes_written: ", $msg);
385 $total_out += $bytes_written;
386 $offset += $bytes_written;
387 $bytes_to_write -= $bytes_written;
389 delete $conn->{send_offset};
392 #last unless $flush; # Go back to select and wait
393 # for it to fire again.
395 # Call me back if queue has not been drained.
397 set_event_handler ($sock, write => undef);
398 if (exists $conn->{close_on_empty}) {
399 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
409 my $oldsock = $conn->{sock};
410 my $rc = $rd_callbacks{$oldsock};
411 my $wc = $wt_callbacks{$oldsock};
412 my $ec = $er_callbacks{$oldsock};
413 my $sock = $oldsock->new_from_fd($oldsock, "w+");
415 set_event_handler($oldsock, read=>undef, write=>undef, error=>undef);
416 $conn->{sock} = $sock;
417 set_event_handler($sock, read=>$rc, write=>$wc, error=>$ec);
422 sub _err_will_block {
423 return 0 unless $blocking_supported;
424 return ($_[0] == $eagain || $_[0] == $ewouldblock || $_[0] == $einprogress);
430 $conn->{close_on_empty} = 1;
433 #-----------------------------------------------------------------
434 # Receive side routines
437 @_ == 4 || die "Msg->new_server (myhost, myport, login_proc\n";
438 my ($pkg, $my_host, $my_port, $login_proc) = @_;
439 my $self = $pkg->new($login_proc);
441 $self->{sock} = $io_socket->new (
442 LocalAddr => "$my_host:$my_port",
443 # LocalPort => $my_port,
447 die "Could not create socket: $! \n" unless $self->{sock};
448 set_event_handler ($self->{sock}, read => sub { $self->new_client } );
457 unless ($main::is_win) {
459 my ($l, $t) = unpack "ll", getsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER);
460 my $k = unpack 'l', getsockopt($conn->{sock}, SOL_SOCKET, SO_KEEPALIVE);
461 my $n = $main::is_win ? 0 : unpack "l", getsockopt($conn->{sock}, IPPROTO_TCP, TCP_NODELAY);
462 dbg("Linger is: $l $t, keepalive: $k, nagle: $n");
465 eval {setsockopt($conn->{sock}, SOL_SOCKET, SO_KEEPALIVE, 1)} or dbg("setsockopt keepalive: $!");
466 eval {setsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER, pack("ll", 0, 0))} or dbg("setsockopt linger: $!");
467 eval {setsockopt($conn->{sock}, IPPROTO_TCP, TCP_NODELAY, 1)} or eval {setsockopt($conn->{sock}, SOL_SOCKET, TCP_NODELAY, 1)} or dbg("setsockopt tcp_nodelay: $!");
468 $conn->{sock}->autoflush(0);
471 my ($l, $t) = unpack "ll", getsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER);
472 my $k = unpack 'l', getsockopt($conn->{sock}, SOL_SOCKET, SO_KEEPALIVE);
473 my $n = $main::is_win ? 0 : unpack "l", getsockopt($conn->{sock}, IPPROTO_TCP, TCP_NODELAY);
474 dbg("Linger is: $l $t, keepalive: $k, nagle: $n");
483 if ($conn->{msg} =~ /\n/) {
484 my @lines = split /\r?\n/, $conn->{msg};
485 if ($conn->{msg} =~ /\n$/) {
488 $conn->{msg} = pop @lines;
491 &{$conn->{rproc}}($conn, defined $_ ? $_ : '');
496 sub _rcv { # Complement to _send
497 my $conn = shift; # $rcv_now complement of $flush
498 # Find out how much has already been received, if at all
499 my ($msg, $offset, $bytes_to_read, $bytes_read);
500 my $sock = $conn->{sock};
501 return unless defined($sock);
504 # if ($conn->{blocking}) {
505 # blocking($sock, 0);
506 # $conn->{blocking} = 0;
508 $bytes_read = sysread ($sock, $msg, 1024, 0);
509 if (defined ($bytes_read)) {
510 if ($bytes_read > 0) {
511 $total_in += $bytes_read;
513 my $call = $conn->{call} || 'none';
514 dbgdump('raw', "$call read $bytes_read: ", $msg);
517 my @ch = split //, $msg;
522 $conn->{msg} =~ s/.$//;
529 set_event_handler ($sock, write => sub{$conn->_send(0)});
530 push @{$conn->{outqueue}}, $out;
533 $conn->{msg} .= $msg;
537 if (_err_will_block($!)) {
545 if (defined $bytes_read && $bytes_read == 0) {
546 &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
549 unless ($conn->{disable_read}) {
550 $conn->dequeue if exists $conn->{msg};
556 my $server_conn = shift;
557 my $sock = $server_conn->{sock}->accept();
559 my $conn = $server_conn->new($server_conn->{rproc});
560 $conn->{sock} = $sock;
563 $conn->{blocking} = 0;
564 my ($rproc, $eproc) = &{$server_conn->{rproc}} ($conn, $conn->{peerhost} = $sock->peerhost(), $conn->{peerport} = $sock->peerport());
565 $conn->{sort} = 'Incoming';
567 $conn->{eproc} = $eproc;
568 set_event_handler ($sock, error => $eproc);
571 $conn->{rproc} = $rproc;
572 my $callback = sub {$conn->_rcv};
573 set_event_handler ($sock, read => $callback);
574 } else { # Login failed
575 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
579 dbg("Msg: error on accept ($!)") if isdbg('err');
586 set_event_handler ($conn->{sock}, read => undef, write => undef, error => undef );
587 $conn->{sock}->close;
590 # close all clients (this is for forking really)
591 sub close_all_clients
593 foreach my $conn (values %conns) {
601 set_event_handler ($conn->{sock}, read => undef);
602 return $_[0] ? $conn->{disable_read} = $_[0] : $_[0];
606 #----------------------------------------------------
607 # Event loop routines used by both client and server
609 sub set_event_handler {
610 shift unless ref($_[0]); # shift if first arg is package name
611 my ($handle, %args) = @_;
613 if (exists $args{'write'}) {
614 $callback = $args{'write'};
616 $wt_callbacks{$handle} = $callback;
617 $wt_handles->add($handle);
619 delete $wt_callbacks{$handle};
620 $wt_handles->remove($handle);
623 if (exists $args{'read'}) {
624 $callback = $args{'read'};
626 $rd_callbacks{$handle} = $callback;
627 $rd_handles->add($handle);
629 delete $rd_callbacks{$handle};
630 $rd_handles->remove($handle);
633 if (exists $args{'error'}) {
634 $callback = $args{'error'};
636 $er_callbacks{$handle} = $callback;
637 $er_handles->add($handle);
639 delete $er_callbacks{$handle};
640 $er_handles->remove($handle);
646 my ($pkg, $loop_count, $timeout, $wronly) = @_; # event_loop(1) to process events once
647 my ($conn, $r, $w, $e, $rset, $wset, $eset);
650 # Quit the loop if no handles left to process
652 last unless $wt_handles->count();
654 ($rset, $wset, $eset) = IO::Select->select(undef, $wt_handles, undef, $timeout);
656 foreach $w (@$wset) {
657 &{$wt_callbacks{$w}}($w) if exists $wt_callbacks{$w};
661 last unless ($rd_handles->count() || $wt_handles->count());
663 ($rset, $wset, $eset) = IO::Select->select($rd_handles, $wt_handles, $er_handles, $timeout);
665 foreach $e (@$eset) {
666 &{$er_callbacks{$e}}($e) if exists $er_callbacks{$e};
668 foreach $r (@$rset) {
669 &{$rd_callbacks{$r}}($r) if exists $rd_callbacks{$r};
671 foreach $w (@$wset) {
672 &{$wt_callbacks{$w}}($w) if exists $wt_callbacks{$w};
678 if (defined($loop_count)) {
679 last unless --$loop_count;
686 my ($pkg, $interval) = @_;
688 while (time - $now < $interval) {
689 $pkg->event_loop(10, 0.01);
696 my $call = $conn->{call} || 'unallocated';
697 my $host = $conn->{peerhost} || '';
698 my $port = $conn->{peerport} || '';
699 dbg("Connection $conn->{cnum} $call [$host $port] being destroyed") if isdbg('connll');