perl/Msg.pm

   1 #
   2 # This has been taken from the 'Advanced Perl Programming' book by Sriram Srinivasan
   3 #
   4 # I am presuming that the code is distributed on the same basis as perl itself.
   5 #
   6 # I have modified it to suit my devious purposes (Dirk Koopman G1TLH)
   7 #
   8 # $Id$
   9 #
  10
  11 package Msg;
  12
  13 require Exporter;
  14 @ISA = qw(Exporter);
  15
  16 use strict;
  17 use IO::Select;
  18 use IO::Socket;
  19 use Carp;
  20
  21 use vars qw (%rd_callbacks %wt_callbacks $rd_handles $wt_handles);
  22
  23 %rd_callbacks = ();
  24 %wt_callbacks = ();
  25 $rd_handles   = IO::Select->new();
  26 $wt_handles   = IO::Select->new();
  27 my $blocking_supported = 0;
  28
  29 BEGIN {
  30     # Checks if blocking is supported
  31     eval {
  32         require POSIX; POSIX->import(qw (F_SETFL O_NONBLOCK EAGAIN));
  33     };
  34     $blocking_supported = 1 unless $@;
  35 }
  36
  37 #-----------------------------------------------------------------
  38 # Send side routines
  39 sub connect {
  40     my ($pkg, $to_host, $to_port,$rcvd_notification_proc) = @_;
  41
  42     # Create a new internet socket
  43
  44     my $sock = IO::Socket::INET->new (
  45                                       PeerAddr => $to_host,
  46                                       PeerPort => $to_port,
  47                                       Proto    => 'tcp',
  48                                       Reuse    => 1);
  49
  50     return undef unless $sock;
  51
  52     # Create a connection end-point object
  53     my $conn = {
  54         sock                   => $sock,
  55         rcvd_notification_proc => $rcvd_notification_proc,
  56     };
  57
  58     if ($rcvd_notification_proc) {
  59         my $callback = sub {_rcv($conn)};
  60         set_event_handler ($sock, "read" => $callback);
  61     }
  62     return bless $conn, $pkg;
  63 }
  64
  65 sub disconnect {
  66     my $conn = shift;
  67     my $sock = delete $conn->{sock};
  68     return unless defined($sock);
  69     set_event_handler ($sock, "read" => undef, "write" => undef);
  70     shutdown($sock, 3);
  71         close($sock);
  72 }
  73
  74 sub send_now {
  75     my ($conn, $msg) = @_;
  76     _enqueue ($conn, $msg);
  77     $conn->_send (1); # 1 ==> flush
  78 }
  79
  80 sub send_later {
  81     my ($conn, $msg) = @_;
  82     _enqueue($conn, $msg);
  83     my $sock = $conn->{sock};
  84     return unless defined($sock);
  85     set_event_handler ($sock, "write" => sub {$conn->_send(0)});
  86 }
  87
  88 sub _enqueue {
  89     my ($conn, $msg) = @_;
  90     # prepend length (encoded as network long)
  91     my $len = length($msg);
  92         $msg =~ s/(\x00-\x2f\x7e-\xff%])/sprintf("%%%02X", ord($1))/eg;
  93     push (@{$conn->{queue}}, $msg . "\n");
  94 }
  95
  96 sub _send {
  97     my ($conn, $flush) = @_;
  98     my $sock = $conn->{sock};
  99     return unless defined($sock);
 100     my ($rq) = $conn->{queue};
 101
 102     # If $flush is set, set the socket to blocking, and send all
 103     # messages in the queue - return only if there's an error
 104     # If $flush is 0 (deferred mode) make the socket non-blocking, and
 105     # return to the event loop only after every message, or if it
 106     # is likely to block in the middle of a message.
 107
 108     $flush ? $conn->set_blocking() : $conn->set_non_blocking();
 109     my $offset = (exists $conn->{send_offset}) ? $conn->{send_offset} : 0;
 110
 111     while (@$rq) {
 112         my $msg            = $rq->[0];
 113                 my $mlth           = length($msg);
 114         my $bytes_to_write = $mlth - $offset;
 115         my $bytes_written  = 0;
 116                 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
 117         while ($bytes_to_write > 0) {
 118             $bytes_written = syswrite ($sock, $msg,
 119                                        $bytes_to_write, $offset);
 120             if (!defined($bytes_written)) {
 121                 if (_err_will_block($!)) {
 122                     # Should happen only in deferred mode. Record how
 123                     # much we have already sent.
 124                     $conn->{send_offset} = $offset;
 125                     # Event handler should already be set, so we will
 126                     # be called back eventually, and will resume sending
 127                     return 1;
 128                 } else {    # Uh, oh
 129                                         delete $conn->{send_offset};
 130                     $conn->handle_send_err($!);
 131                     return 0; # fail. Message remains in queue ..
 132                 }
 133             }
 134             $offset         += $bytes_written;
 135             $bytes_to_write -= $bytes_written;
 136         }
 137         delete $conn->{send_offset};
 138         $offset = 0;
 139         shift @$rq;
 140         last unless $flush; # Go back to select and wait
 141                             # for it to fire again.
 142     }
 143     # Call me back if queue has not been drained.
 144     if (@$rq) {
 145         set_event_handler ($sock, "write" => sub {$conn->_send(0)});
 146     } else {
 147         set_event_handler ($sock, "write" => undef);
 148     }
 149     1;  # Success
 150 }
 151
 152 sub _err_will_block {
 153     if ($blocking_supported) {
 154         return ($_[0] == EAGAIN());
 155     }
 156     return 0;
 157 }
 158 sub set_non_blocking {                        # $conn->set_blocking
 159     if ($blocking_supported) {
 160         # preserve other fcntl flags
 161         my $flags = fcntl ($_[0], F_GETFL(), 0);
 162         fcntl ($_[0], F_SETFL(), $flags | O_NONBLOCK());
 163     }
 164 }
 165 sub set_blocking {
 166     if ($blocking_supported) {
 167         my $flags = fcntl ($_[0], F_GETFL(), 0);
 168         $flags  &= ~O_NONBLOCK(); # Clear blocking, but preserve other flags
 169         fcntl ($_[0], F_SETFL(), $flags);
 170     }
 171 }
 172
 173 sub handle_send_err {
 174    # For more meaningful handling of send errors, subclass Msg and
 175    # rebless $conn.
 176    my ($conn, $err_msg) = @_;
 177    warn "Error while sending: $err_msg \n";
 178    set_event_handler ($conn->{sock}, "write" => undef);
 179 }
 180
 181 #-----------------------------------------------------------------
 182 # Receive side routines
 183
 184 my ($g_login_proc,$g_pkg);
 185 my $main_socket = 0;
 186 sub new_server {
 187     @_ == 4 || die "Msg->new_server (myhost, myport, login_proc)\n";
 188     my ($pkg, $my_host, $my_port, $login_proc) = @_;
 189
 190     $main_socket = IO::Socket::INET->new (
 191                                           LocalAddr => $my_host,
 192                                           LocalPort => $my_port,
 193                                           Listen    => 5,
 194                                           Proto     => 'tcp',
 195                                           Reuse     => 1);
 196     die "Could not create socket: $! \n" unless $main_socket;
 197     set_event_handler ($main_socket, "read" => \&_new_client);
 198     $g_login_proc = $login_proc; $g_pkg = $pkg;
 199 }
 200
 201 sub _rcv {                     # Complement to _send
 202     my $conn = shift; # $rcv_now complement of $flush
 203     # Find out how much has already been received, if at all
 204     my ($msg, $offset, $bytes_to_read, $bytes_read);
 205     my $sock = $conn->{sock};
 206     return unless defined($sock);
 207
 208         my @lines;
 209     $conn->set_non_blocking();
 210         $bytes_read = sysread ($sock, $msg, 1024, 0);
 211         if (defined ($bytes_read)) {
 212                 if ($bytes_read > 0) {
 213                         if ($msg =~ /\n/) {
 214                                 @lines = split /\n/, $msg;
 215                                 $lines[0] = $conn->{msg} . $lines[0] if $conn->{msg};
 216                                 if ($msg =~ /\n$/) {
 217                                         delete $conn->{msg};
 218                                 } else {
 219                                         $conn->{msg} = pop @lines;
 220                                 }
 221                         } else {
 222                                 $conn->{msg} .= $msg;
 223                         }
 224                 }
 225         } else {
 226                 if (_err_will_block($!)) {
 227                         return ;
 228                 } else {
 229                         $bytes_read = 0;
 230                 }
 231     }
 232
 233 FINISH:
 234     if (defined $bytes_read == 0) {
 235                 $conn->disconnect();
 236                 &{$conn->{rcvd_notification_proc}}($conn, undef, $!);
 237     }
 238
 239         while (@lines){
 240                 $msg = shift @lines;
 241                 $msg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
 242                 &{$conn->{rcvd_notification_proc}}($conn, $msg, $!);
 243                 $! = 0;
 244         }
 245 }
 246
 247 sub _new_client {
 248     my $sock = $main_socket->accept();
 249     my $conn = bless {
 250         'sock' =>  $sock,
 251         'state' => 'connected'
 252     }, $g_pkg;
 253     my $rcvd_notification_proc =
 254         &$g_login_proc ($conn, $sock->peerhost(), $sock->peerport());
 255     if ($rcvd_notification_proc) {
 256         $conn->{rcvd_notification_proc} = $rcvd_notification_proc;
 257         my $callback = sub {_rcv($conn)};
 258         set_event_handler ($sock, "read" => $callback);
 259     } else {  # Login failed
 260         $conn->disconnect();
 261     }
 262 }
 263
 264 sub close_server
 265 {
 266         set_event_handler ($main_socket, "read" => undef);
 267         $main_socket->close;
 268         $main_socket = 0;
 269 }
 270
 271 #----------------------------------------------------
 272 # Event loop routines used by both client and server
 273
 274 sub set_event_handler {
 275     shift unless ref($_[0]); # shift if first arg is package name
 276     my ($handle, %args) = @_;
 277     my $callback;
 278     if (exists $args{'write'}) {
 279         $callback = $args{'write'};
 280         if ($callback) {
 281             $wt_callbacks{$handle} = $callback;
 282             $wt_handles->add($handle);
 283         } else {
 284             delete $wt_callbacks{$handle};
 285             $wt_handles->remove($handle);
 286         }
 287     }
 288     if (exists $args{'read'}) {
 289         $callback = $args{'read'};
 290         if ($callback) {
 291             $rd_callbacks{$handle} = $callback;
 292             $rd_handles->add($handle);
 293         } else {
 294             delete $rd_callbacks{$handle};
 295             $rd_handles->remove($handle);
 296        }
 297     }
 298 }
 299
 300 sub event_loop {
 301     my ($pkg, $loop_count, $timeout) = @_; # event_loop(1) to process events once
 302     my ($conn, $r, $w, $rset, $wset);
 303     while (1) {
 304         # Quit the loop if no handles left to process
 305         last unless ($rd_handles->count() || $wt_handles->count());
 306         ($rset, $wset) =
 307             IO::Select->select ($rd_handles, $wt_handles, undef, $timeout);
 308         foreach $r (@$rset) {
 309             &{$rd_callbacks{$r}} ($r) if exists $rd_callbacks{$r};
 310         }
 311         foreach $w (@$wset) {
 312             &{$wt_callbacks{$w}}($w) if exists $wt_callbacks{$w};
 313         }
 314         if (defined($loop_count)) {
 315             last unless --$loop_count;
 316         }
 317     }
 318 }
 319
 320 1;
 321
 322 __END__
 323