openwferu-scheduler 0.9.11 → 0.9.12.826

data/lib/openwfe/util/otime.rb

@@ -51,7 +51,8 @@ module OpenWFE
     # Returns the current time as an ISO date string
     #
     def OpenWFE.now ()
-        return to_iso8601_date(Time.new())
+
+        to_iso8601_date(Time.new())
     end
 
     def OpenWFE.to_iso8601_date (date)
@@ -64,10 +65,10 @@ module OpenWFE
             date = DateTime.parse(date)
         end
 
-        s = date.to_s
+        s = date.to_s # this is costly
         s[10] = " "
 
-        return s
+        s
     end
 
     #
@@ -89,7 +90,7 @@ module OpenWFE
     #
     def OpenWFE.to_ruby_time (iso_date)
 
-        return DateTime.parse(iso_date)
+        DateTime.parse(iso_date)
     end
 
     #def OpenWFE.parse_date (date)
@@ -102,7 +103,7 @@ module OpenWFE
 
         t = Time.new()
         t = t.to_f * 1000
-        return t.to_i
+        t.to_i
     end
 
     #
@@ -154,7 +155,7 @@ module OpenWFE
             result = result + (value * multiplier)
         end
 
-        return result
+        result
     end
 
     #
@@ -163,7 +164,7 @@ module OpenWFE
     def OpenWFE.is_digit? (c)
         return false if not c.kind_of?(String)
         return false if c.length > 1
-        return (c >= "0" and c <= "9")
+        (c >= "0" and c <= "9")
     end
 
     #
@@ -185,7 +186,7 @@ module OpenWFE
 
         begin
 
-            return DateTime.new(
+            DateTime.new(
                 time.year, 
                 time.month, 
                 time.day, 
@@ -204,7 +205,7 @@ module OpenWFE
             #    "\n....y:#{time.year} M:#{time.month} d:#{time.day} "+
             #    "h:#{time.hour} m:#{time.min} s:#{s} o:#{o}"
 
-            return DateTime.new(
+            DateTime.new(
                 time.year, 
                 time.month, 
                 time.day, 
@@ -223,7 +224,7 @@ module OpenWFE
         to_ttime(dtime.new_offset(DateTime.now.offset-offset), :local)
     end
 
-    def to_ttime (d, method)
+    def OpenWFE.to_ttime (d, method)
         usec = (d.sec_fraction * 3600 * 24 * (10**6)).to_i
         Time.send(method, d.year, d.month, d.day, d.hour, d.min, d.sec, usec)
     end

data/lib/openwfe/util/scheduler.rb

@@ -40,7 +40,6 @@
 #
 
 require 'monitor'
-
 require 'openwfe/util/otime'
 
 
@@ -105,14 +104,31 @@ module OpenWFE
     # This attribute is best used indirectly : the method 
     # join_until_no_more_jobs() wraps it.
     #
+    # Since OpenWFEru 0.9.13, the :scheduler_precision can be set when
+    # instantiating the scheduler.
+    #
+    #     scheduler = OpenWFE::Scheduler.new(:scheduler_precision => 0.500)
+    #     scheduler.start
+    #         #
+    #         # instatiates a scheduler that checks its jobs twice per second
+    #         # (the default is 4 times per second (0.250))
+    #
     class Scheduler
         include MonitorMixin
 
-        attr_accessor \
-            :precision,
-            :exit_when_no_more_jobs
+        #
+        # By default, the precision is 0.250, with means the scheduler
+        # will check for jobs to execute 4 times per second.
+        #
+        attr_accessor :precision
 
-        def initialize
+        #
+        # As its name implies.
+        #
+        attr_accessor :stopped
+
+
+        def initialize (params={})
 
             super()
 
@@ -122,15 +138,19 @@ module OpenWFE
             @scheduler_thread = nil
 
             @precision = 0.250
-                #
-                # every 250ms, the scheduler wakes up
+                # every 250ms, the scheduler wakes up (default value)
+            begin
+                @precision = Float(params[:scheduler_precision])
+            rescue Exception => e
+                # let precision at its default value
+            end
 
             @exit_when_no_more_jobs = false
             @dont_reschedule_every = false
 
             @last_cron_minute = -1
 
-            @stopped = false
+            @stopped = true
         end
 
         #
@@ -138,11 +158,19 @@ module OpenWFE
         #
         def sstart
 
+            @stopped = false
+
             @scheduler_thread = Thread.new do
+
+                if defined?(JRUBY_VERSION)
+                    require 'java'
+                    java.lang.Thread.current_thread.name = "openwferu scheduler (Ruby Thread)"
+                end
+
                 while true
                     break if @stopped
                     step
-                    sleep(@precision)
+                    sleep @precision
                 end
             end
         end
@@ -184,6 +212,9 @@ module OpenWFE
         # Schedules a job by specifying at which time it should trigger.
         # Returns the a job_id that can be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule_at (at, params={}, &block)
 
             params = prepare_params(params)
@@ -196,6 +227,9 @@ module OpenWFE
         # Schedules a job by stating in how much time it should trigger.
         # Returns the a job_id that can be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule_in (duration, params={}, &block)
 
             duration = duration_to_f(duration)
@@ -218,6 +252,9 @@ module OpenWFE
         #         end
         #     end
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule_every (freq, params={}, &block)
 
             f = duration_to_f freq
@@ -277,7 +314,7 @@ module OpenWFE
         #
         # Schedules a cron job, the 'cron_line' is a string
         # following the Unix cron standard (see "man 5 crontab" in your command 
-        # line).
+        # line, or http://www.google.com/search?q=man%205%20crontab).
         #
         # For example :
         #
@@ -296,8 +333,10 @@ module OpenWFE
         # Returns the job id attributed to this 'cron job', this id can
         # be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule (cron_line, params={}, &block)
-
             synchronize do
 
                 params = prepare_params(params)
@@ -397,8 +436,11 @@ module OpenWFE
                 params
             end
 
+            #
+            # The core method behind schedule_at and schedule_in (and also
+            # schedule_every). It's protected, don't use it directly.
+            #
             def sschedule_at (at, params={}, &block)
-
                 synchronize do
 
                     #puts "0 at is '#{at.to_s}' (#{at.class})"
@@ -428,7 +470,7 @@ module OpenWFE
                     unschedule(job_id) if job_id 
 
                     if at < (Time.new.to_f + @precision)
-                        job.trigger()
+                        job.trigger() unless params[:discard_past]
                         return nil
                     end
 
@@ -509,7 +551,7 @@ module OpenWFE
 
                 #puts "push() at '#{Time.at(job.at)}'"
 
-                return job.eid
+                job.eid
             end
 
             #

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: openwferu-scheduler
 version: !ruby/object:Gem::Version 
-  version: 0.9.11
-date: 2007-06-06 00:00:00 +09:00
+  version: 0.9.12.826
+date: 2007-07-20 00:00:00 +09:00
 summary: OpenWFEru scheduler for Ruby (at, cron and every)
 require_paths: 
 - lib