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)
15 use vars qw($VERSION $BRANCH);
16 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
17 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
18 $main::build += $VERSION;
19 $main::branch += $BRANCH;
26 use vars qw(%rd_callbacks %wt_callbacks %er_callbacks $rd_handles $wt_handles $er_handles $now %conns $noconns $blocking_supported $cnum);
31 $rd_handles = IO::Select->new();
32 $wt_handles = IO::Select->new();
33 $er_handles = IO::Select->new();
38 # Checks if blocking is supported
40 require POSIX; POSIX->import(qw(O_NONBLOCK F_SETFL F_GETFL))
42 if ($@ || $main::is_win) {
43 # print STDERR "POSIX Blocking *** NOT *** supported $@\n";
44 $blocking_supported = 0;
46 $blocking_supported = 1;
47 # print STDERR "POSIX Blocking enabled\n";
51 # import as many of these errno values as are available
53 require Errno; Errno->import(qw(EAGAIN EINPROGRESS EWOULDBLOCK));
59 my $eagain = eval {EAGAIN()};
60 my $einprogress = eval {EINPROGRESS()};
61 my $ewouldblock = eval {EWOULDBLOCK()};
67 #-----------------------------------------------------------------
68 # Generalised initializer
72 my ($pkg, $rproc) = @_;
74 my $class = $obj || $pkg;
85 cnum => (($cnum < 999) ? (++$cnum) : ($cnum = 1)),
90 dbg("Connection created ($noconns)") if isdbg('connll');
91 return bless $conn, $class;
98 $conn->{eproc} = $callback;
99 set_event_handler($conn->{sock}, error => $callback) if exists $conn->{sock};
105 my $callback = shift;
106 $conn->{rproc} = $callback;
111 return unless $blocking_supported;
113 my $flags = fcntl ($_[0], F_GETFL, 0);
115 $flags &= ~O_NONBLOCK;
117 $flags |= O_NONBLOCK;
119 fcntl ($_[0], F_SETFL, $flags);
130 $call = $pkg->{call} unless $call;
131 return undef unless $call;
132 dbg("changing $pkg->{call} to $call") if isdbg('connll') && exists $pkg->{call} && $call ne $pkg->{call};
133 delete $conns{$pkg->{call}} if exists $pkg->{call} && exists $conns{$pkg->{call}} && $pkg->{call} ne $call;
134 $pkg->{call} = $call;
135 $ref = $conns{$call} = $pkg;
136 dbg("Connection $pkg->{cnum} $call stored") if isdbg('connll');
138 $ref = $conns{$call};
143 # this is only called by any dependent processes going away unexpectedly
146 my ($pkg, $pid) = @_;
148 my @pid = grep {$_->{pid} == $pid} values %conns;
149 foreach my $p (@pid) {
150 &{$p->{eproc}}($p, "$pid has gorn") if exists $p->{eproc};
155 #-----------------------------------------------------------------
158 my ($pkg, $to_host, $to_port, $rproc) = @_;
160 # Create a connection end-point object
163 $conn = $pkg->new($rproc);
165 $conn->{peerhost} = $to_host;
166 $conn->{peerport} = $to_port;
167 $conn->{sort} = 'Outgoing';
169 # Create a new internet socket
170 my $sock = IO::Socket::INET->new();
171 return undef unless $sock;
173 my $proto = getprotobyname('tcp');
174 $sock->socket(AF_INET, SOCK_STREAM, $proto) or return undef;
177 $conn->{blocking} = 0;
179 my $ip = gethostbyname($to_host);
180 # my $r = $sock->connect($to_port, $ip);
181 my $r = connect($sock, pack_sockaddr_in($to_port, $ip));
182 return undef unless $r || _err_will_block($!);
184 $conn->{sock} = $sock;
186 if ($conn->{rproc}) {
187 my $callback = sub {$conn->_rcv};
188 set_event_handler ($sock, read => $callback);
195 return if exists $conn->{disconnecting};
197 $conn->{disconnecting} = 1;
198 my $sock = delete $conn->{sock};
199 $conn->{state} = 'E';
200 $conn->{timeout}->del if $conn->{timeout};
202 # be careful to delete the correct one
204 if ($call = $conn->{call}) {
205 my $ref = $conns{$call};
206 delete $conns{$call} if $ref && $ref == $conn;
208 $call ||= 'unallocated';
209 dbg("Connection $conn->{cnum} $call disconnected") if isdbg('connll');
211 # get rid of any references
213 if (ref($conn->{$_})) {
218 if (defined($sock)) {
219 set_event_handler ($sock, read => undef, write => undef, error => undef);
224 unless ($main::is_win) {
225 kill 'TERM', $conn->{pid} if exists $conn->{pid};
231 my ($conn, $msg) = @_;
232 $conn->enqueue($msg);
233 $conn->_send (1); # 1 ==> flush
237 my ($conn, $msg) = @_;
238 $conn->enqueue($msg);
239 my $sock = $conn->{sock};
240 return unless defined($sock);
241 set_event_handler ($sock, write => sub {$conn->_send(0)});
246 push (@{$conn->{outqueue}}, defined $_[0] ? $_[0] : '');
250 my ($conn, $flush) = @_;
251 my $sock = $conn->{sock};
252 return unless defined($sock);
253 my $rq = $conn->{outqueue};
255 # If $flush is set, set the socket to blocking, and send all
256 # messages in the queue - return only if there's an error
257 # If $flush is 0 (deferred mode) make the socket non-blocking, and
258 # return to the event loop only after every message, or if it
259 # is likely to block in the middle of a message.
261 if ($conn->{blocking} != $flush) {
262 blocking($sock, $flush);
263 $conn->{blocking} = $flush;
265 my $offset = (exists $conn->{send_offset}) ? $conn->{send_offset} : 0;
269 my $mlth = length($msg);
270 my $bytes_to_write = $mlth - $offset;
271 my $bytes_written = 0;
272 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
273 while ($bytes_to_write > 0) {
274 $bytes_written = syswrite ($sock, $msg,
275 $bytes_to_write, $offset);
276 if (!defined($bytes_written)) {
277 if (_err_will_block($!)) {
278 # Should happen only in deferred mode. Record how
279 # much we have already sent.
280 $conn->{send_offset} = $offset;
281 # Event handler should already be set, so we will
282 # be called back eventually, and will resume sending
285 &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
287 return 0; # fail. Message remains in queue ..
289 } elsif (isdbg('raw')) {
290 my $call = $conn->{call} || 'none';
291 dbgdump('raw', "$call send $bytes_written: ", $msg);
293 $offset += $bytes_written;
294 $bytes_to_write -= $bytes_written;
296 delete $conn->{send_offset};
299 #last unless $flush; # Go back to select and wait
300 # for it to fire again.
302 # Call me back if queue has not been drained.
304 set_event_handler ($sock, write => undef);
305 if (exists $conn->{close_on_empty}) {
306 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
316 my $oldsock = $conn->{sock};
317 my $rc = $rd_callbacks{$oldsock};
318 my $wc = $wt_callbacks{$oldsock};
319 my $ec = $er_callbacks{$oldsock};
320 my $sock = $oldsock->new_from_fd($oldsock, "w+");
322 set_event_handler($oldsock, read=>undef, write=>undef, error=>undef);
323 $conn->{sock} = $sock;
324 set_event_handler($sock, read=>$rc, write=>$wc, error=>$ec);
329 sub _err_will_block {
330 return 0 unless $blocking_supported;
331 return ($_[0] == $eagain || $_[0] == $ewouldblock || $_[0] == $einprogress);
337 $conn->{close_on_empty} = 1;
340 #-----------------------------------------------------------------
341 # Receive side routines
344 @_ == 4 || die "Msg->new_server (myhost, myport, login_proc\n";
345 my ($pkg, $my_host, $my_port, $login_proc) = @_;
346 my $self = $pkg->new($login_proc);
348 $self->{sock} = IO::Socket::INET->new (
349 LocalAddr => "$my_host:$my_port",
350 # LocalPort => $my_port,
354 die "Could not create socket: $! \n" unless $self->{sock};
355 set_event_handler ($self->{sock}, read => sub { $self->new_client } );
363 if (isdbg('sock') && ($buf = getsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER))) {
364 my ($l, $t) = unpack("ll", $buf);
365 dbg("Linger is: $buf = $l $t");
367 setsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER, pack("ll", 0, 0)) or confess "setsockopt linger: $!";
368 setsockopt($conn->{sock}, SOL_SOCKET, SO_KEEPALIVE, 1) or confess "setsockopt keepalive: $!";
369 if (isdbg('sock') && ($buf = getsockopt($conn->{sock}, SOL_SOCKET, SO_LINGER))) {
370 my ($l, $t) = unpack("ll", $buf);
371 dbg("Linger is: $buf = $l $t");
379 if ($conn->{msg} =~ /\n/) {
380 my @lines = split /\r?\n/, $conn->{msg};
381 if ($conn->{msg} =~ /\n$/) {
384 $conn->{msg} = pop @lines;
387 &{$conn->{rproc}}($conn, defined $_ ? $_ : '');
392 sub _rcv { # Complement to _send
393 my $conn = shift; # $rcv_now complement of $flush
394 # Find out how much has already been received, if at all
395 my ($msg, $offset, $bytes_to_read, $bytes_read);
396 my $sock = $conn->{sock};
397 return unless defined($sock);
400 if ($conn->{blocking}) {
402 $conn->{blocking} = 0;
404 $bytes_read = sysread ($sock, $msg, 1024, 0);
405 if (defined ($bytes_read)) {
406 if ($bytes_read > 0) {
408 my $call = $conn->{call} || 'none';
409 dbgdump('raw', "$call read $bytes_read: ", $msg);
412 my @ch = split //, $msg;
417 $conn->{msg} =~ s/.$//;
424 set_event_handler ($sock, write => sub{$conn->_send(0)});
425 push @{$conn->{outqueue}}, $out;
428 $conn->{msg} .= $msg;
432 if (_err_will_block($!)) {
440 if (defined $bytes_read && $bytes_read == 0) {
441 &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
444 unless ($conn->{disable_read}) {
445 $conn->dequeue if exists $conn->{msg};
451 my $server_conn = shift;
452 my $sock = $server_conn->{sock}->accept();
454 my $conn = $server_conn->new($server_conn->{rproc});
455 $conn->{sock} = $sock;
458 $conn->{blocking} = 0;
459 my ($rproc, $eproc) = &{$server_conn->{rproc}} ($conn, $conn->{peerhost} = $sock->peerhost(), $conn->{peerport} = $sock->peerport());
460 $conn->{sort} = 'Incoming';
462 $conn->{eproc} = $eproc;
463 set_event_handler ($sock, error => $eproc);
466 $conn->{rproc} = $rproc;
467 my $callback = sub {$conn->_rcv};
468 set_event_handler ($sock, read => $callback);
469 } else { # Login failed
470 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
474 dbg("Msg: error on accept ($!)") if isdbg('err');
481 set_event_handler ($conn->{sock}, read => undef, write => undef, error => undef );
482 $conn->{sock}->close;
485 # close all clients (this is for forking really)
486 sub close_all_clients
488 foreach my $conn (values %conns) {
496 set_event_handler ($conn->{sock}, read => undef);
497 return $_[0] ? $conn->{disable_read} = $_[0] : $_[0];
501 #----------------------------------------------------
502 # Event loop routines used by both client and server
504 sub set_event_handler {
505 shift unless ref($_[0]); # shift if first arg is package name
506 my ($handle, %args) = @_;
508 if (exists $args{'write'}) {
509 $callback = $args{'write'};
511 $wt_callbacks{$handle} = $callback;
512 $wt_handles->add($handle);
514 delete $wt_callbacks{$handle};
515 $wt_handles->remove($handle);
518 if (exists $args{'read'}) {
519 $callback = $args{'read'};
521 $rd_callbacks{$handle} = $callback;
522 $rd_handles->add($handle);
524 delete $rd_callbacks{$handle};
525 $rd_handles->remove($handle);
528 if (exists $args{'error'}) {
529 $callback = $args{'error'};
531 $er_callbacks{$handle} = $callback;
532 $er_handles->add($handle);
534 delete $er_callbacks{$handle};
535 $er_handles->remove($handle);
541 my ($pkg, $loop_count, $timeout) = @_; # event_loop(1) to process events once
542 my ($conn, $r, $w, $e, $rset, $wset, $eset);
545 # Quit the loop if no handles left to process
546 last unless ($rd_handles->count() || $wt_handles->count());
548 ($rset, $wset, $eset) = IO::Select->select($rd_handles, $wt_handles, $er_handles, $timeout);
550 foreach $e (@$eset) {
551 &{$er_callbacks{$e}}($e) if exists $er_callbacks{$e};
553 foreach $r (@$rset) {
554 &{$rd_callbacks{$r}}($r) if exists $rd_callbacks{$r};
556 foreach $w (@$wset) {
557 &{$wt_callbacks{$w}}($w) if exists $wt_callbacks{$w};
562 if (defined($loop_count)) {
563 last unless --$loop_count;
570 my ($pkg, $interval) = @_;
572 while (time - $now < $interval) {
573 $pkg->event_loop(10, 0.01);
580 my $call = $conn->{call} || 'unallocated';
581 my $host = $conn->{peerhost} || '';
582 my $port = $conn->{peerport} || '';
583 dbg("Connection $conn->{cnum} $call [$host $port] being destroyed") if isdbg('connll');