Changeset 2924

Timestamp:

08/21/10 22:56:15 (18 months ago)

Author:

karpet

Message:

add use_native_signals feature; release 0.05

Location:

Catalyst-Plugin-Alarm/trunk

Files:

• Alarm.pm (modified) (14 diffs)
• Changes (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• Makefile.PL (modified) (1 diff)
• README (modified) (2 diffs)
• t/00-load.t (modified) (1 diff)
• t/01-alarm.t (modified) (1 diff)
• t/02-native-signals.t (added)
• t/TestApp.pm (modified) (1 diff)

Catalyst-Plugin-Alarm/trunk/Alarm.pm

@@ -15 +15 @@
 # Sys::SigAction doesn't help on Win32 systems
 # because Win32 doesn't use POSIX signals
-our $WIN32 = 1;
-unless ( $^O eq 'MSWin32' ) {
-    require Sys::SigAction;
-    $WIN32 = 0;
+our $USE_NATIVE_SIGNALS = 0;
+if ( $^O eq 'MSWin32' ) {
+    $USE_NATIVE_SIGNALS = 1;
 }
 
@@ -32 +31 @@
 }
 
+sub setup_finalize {
+    my $c   = shift;
+    my $ret = $c->next::method(@_);
+
+    my %conf = %{ $c->config->{alarm} };
+
+    if ( $conf{use_native_signals} ) {
+        $USE_NATIVE_SIGNALS = 1;
+    }
+    else {
+        require Sys::SigAction;    # defer till runtime
+    }
+
+    return $ret;
+}
+
+# must call on every request
 sub prepare {
     my $class = shift;
@@ -105 +121 @@
         };
 
-        if ($WIN32) {
+        if ($USE_NATIVE_SIGNALS) {
             $SIG{ALRM} = $alarm_handler;
         }
@@ -239 +255 @@
     eval {
         my $h = $SIG{ALRM};
-        if ($WIN32) {
+        if ($USE_NATIVE_SIGNALS) {
             $SIG{ALRM} = $alarm_handler;
         }
@@ -288 +304 @@
         CORE::alarm($prev_alarm);
 
-        if ($WIN32) {
+        if ($USE_NATIVE_SIGNALS) {
             $SIG{ALRM} = $h;
         }
@@ -352 +368 @@
  package MyApp;
  use Catalyst qw( Alarm );
- MyApp->config->{alarm} = {
+ MyApp->config( alarm => {
     timeout => 60,
     global  => 120,
     handler => sub { # do something if alarm sounds }
-    };
+ });
  
- sub default : Private
- {
+ sub default : Private {
      my ($self,$c) = @_;
-     unless( $c->timeout('foo') )
-     {
+     unless( $c->timeout('foo') ) {
         $c->stash->{error} = "Sorry to keep you waiting. There was a problem.";
         return;
@@ -368 +382 @@
  }
  
- sub foo : Private
- {
+ sub foo : Private {
     my ($self,$c) = @_;
     sleep 61;  
@@ -443 +456 @@
   __PACKAGE__->config( alarm => {
     handler => sub {
-        if (ref $_[1])
-        {
+        if (ref $_[1]) {
             $_[0]->log->error(" .... local alarm went off!!");
             $_[1]->[0] = 'some return value';
             $_[0]->alarm->on(0);    # turn 'off' the alarm flag
         }
-        else
-        {
+        else {
             $_[0]->log->error(" .... global alarm went off");
             $_[0]->alarm->on(1);
@@ -466 +477 @@
 Example:
 
-  __PACKAGE__->config( alarm => {
-         override => {
-            re=> qr{/ajax/}, 
-            timeout=> 3
-           }
-         });
+ __PACKAGE__->config( alarm => {
+    override => {
+        re=> qr{/ajax/}, 
+        timeout=> 3
+    }
+ });
  
 Will set the global timeout value to 3 if the request->path matches C</ajax>.
@@ -486 +497 @@
     forward => 1, 
     timeout => 10 
-   });
+ });
  
 Will automatically call timeout() with a default value of 10 seconds, wherever your
@@ -494 +505 @@
 feature.
 
+=item use_native_signals
+
+Default value is false. If set to a true value, Sys::SigAction will not be used
+and instead the built-in %SIG handlers will be used. This is necessary for the plugin
+to work under Win32 systems and in some cases with FCGI.
 
 =back
@@ -536 +552 @@
 
 
+=head2 setup_finalize
+
+Overridden internally.
+
 =head2 prepare
 
@@ -565 +585 @@
 
  __PACKAGE__->config( alarm => {
-                             override => {
-                                re      => qr{/foo/},
-                                timeout => 3 
-                                }
-                            } );
- sub foo : Global
- {
+    override => {
+        re      => qr{/foo/},
+        timeout => 3 
+    }
+ });
+ 
+ sub foo : Global {
    my ($self,$c) = @_;
    $c->alarm->off;      # negates the override in config
@@ -655 +675 @@
 for more details.
 
-Win32 systems don't have alarm() or other signal handlers. That's not really the fault
-of this module, but listed here in case you try using this on a Win32 system and it balks.
-You might try setting the PERL_SIGNALS environment variable to C<unsafe> but that wouldn't
-be very safe, now would it?
+Win32 systems don't have alarm() or other signal handlers, so B<use_native_signals>
+gets turned on if running under Win32.
+
+Some users report that Sys::SigAction does not play nicely with FCGI,
+so you can set the B<use_native_signals> to a true value to use the built-in
+%SIG handlers instead of Sys::SigAction.
 
 =head1 AUTHOR

Catalyst-Plugin-Alarm/trunk/Changes

@@ -14 +14 @@
       instead of NEXT.
 
-
+0.05  21 Aug 2010
+    - add 'use_native_signals' config option to avoid dependency
+      on Sys::SigAction (see https://rt.cpan.org/Ticket/Display.html?id=60566)

Catalyst-Plugin-Alarm/trunk/MANIFEST

@@ -5 +5 @@
 t/00-load.t
 t/01-alarm.t
+t/02-native-signals.t
 t/TestApp/Controller/Root.pm
 t/TestApp.pm

Catalyst-Plugin-Alarm/trunk/Makefile.PL

@@ -4 +4 @@
 
 WriteMakefile(
-    NAME              => 'Catalyst::Plugin::Alarm',
-    VERSION_FROM      => 'Alarm.pm',
-    PREREQ_PM         => {
-                     'Sys::SigAction' => 0.04, 
-                     'Time::HiRes'    => 1.0,
-                     'Class::Accessor::Fast' => 0,
-                     'Catalyst::Runtime'     => 5.7,
-                     'MRO::Compat' => 0,
+    NAME         => 'Catalyst::Plugin::Alarm',
+    VERSION_FROM => 'Alarm.pm',
+    PREREQ_PM    => {
+        'Sys::SigAction'        => 0.11,
+        'Time::HiRes'           => 1.0,
+        'Class::Accessor::Fast' => 0,
+        'Catalyst::Runtime'     => 5.8,
+        'MRO::Compat'           => 0,
 
-                     }, 
-    AUTHOR            => 'Peter Karman <pkarman@atomiclearning.com>',
-    dist              => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
-    clean             => { FILES => 'Catalyst-Plugin-Alarm-*' },
+    },
+    AUTHOR => 'Peter Karman <karman@cpan.org>',
+    dist   => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
+    clean => { FILES => 'Catalyst-Plugin-Alarm-*' },
 
 );

Catalyst-Plugin-Alarm/trunk/README

@@ -1 @@
-Catalyst::Plugin::Alarm version 0.01
+Catalyst::Plugin::Alarm
 ================
 
-Implements Sys::SigAction alarms with Time::HiRes for Catalyst.
+Implements alarms with Time::HiRes for Catalyst.
 
 INSTALLATION
@@ -17 +17 @@
 This module requires these other modules and libraries:
 
-  Sys::SigAction
+  Sys::SigAction (optional)
   Time::HiRes
 

Catalyst-Plugin-Alarm/trunk/t/00-load.t

@@ -1 +1 @@
 use Test::More tests => 1;
-BEGIN { use_ok('Alarm') };
+BEGIN { use_ok('Alarm') }
 
-diag( "Testing Catalyst::Plugin::Alarm $Catalyst::Plugin::Alarm::VERSION" );
-diag( "Testing Sys::SigAction $Sys::SigAction::VERSION" );
+diag("Testing Catalyst::Plugin::Alarm $Catalyst::Plugin::Alarm::VERSION");
 
+eval {
+    require Sys::SigAction;
+    diag("Testing Sys::SigAction $Sys::SigAction::VERSION");
+};

Catalyst-Plugin-Alarm/trunk/t/01-alarm.t

@@ -3 +3 @@
 use Catalyst::Test 'TestApp';
 use Test::More tests => 7;
+
+diag("USE_NATIVE_SIGNALS = $Catalyst::Plugin::Alarm::USE_NATIVE_SIGNALS");
 
 # some tests defined in the TestApp files

Catalyst-Plugin-Alarm/trunk/t/TestApp.pm

@@ -20 +20 @@
             }
         },
-        global => 5
+        global             => 5,
+        use_native_signals => $ENV{USE_NATIVE_SIGNALS},
     },
 );