openwferu-scheduler 0.9.15.1127 → 0.9.15.1128

data/lib/openwfe/util/scheduler.rb

@@ -53,7 +53,7 @@ module OpenWFE
     # params (usually an array or nil), either a block, which is more in the 
     # Ruby way.
     #
-    # Two examples :
+    # Some examples :
     #     
     #    scheduler.schedule_in("3d") do
     #        regenerate_monthly_report()
@@ -62,7 +62,16 @@ module OpenWFE
     #        # will call the regenerate_monthly_report method 
     #        # in 3 days from now
     #
-    # and
+    #     scheduler.schedule "0 22 * * 1-5" do 
+    #         log.info "activating security system..."
+    #         activate_security_system()
+    #     end
+    #
+    #     job_id = scheduler.schedule_at "Sun Oct 07 14:24:01 +0900 2009" do
+    #         init_self_destruction_sequence()
+    #     end
+    #
+    # an example that uses a Schedulable class :
     #
     #    class Regenerator < Schedulable
     #        def trigger (frequency)
@@ -122,6 +131,7 @@ module OpenWFE
     #     end
     #
     #     jobs = find_jobs 'backup'
+    #     jobs.each { |job| job.unschedule }
     #
     # Multiple tags may be attached to a single job :
     #
@@ -390,7 +400,7 @@ module OpenWFE
                 # schedule
 
                 b = to_block(params, &block)
-                job = CronJob.new(cron_id, cron_line, tags, &b)
+                job = CronJob.new(self, cron_id, cron_line, tags, &b)
                 @cron_jobs[job.job_id] = job
 
                 job.job_id
@@ -536,7 +546,7 @@ module OpenWFE
                     tags = params[:tags]
 
                     b = to_block(params, &block)
-                    job = jobClass.new(at, job_id, tags, &b)
+                    job = jobClass.new(self, at, job_id, tags, &b)
 
                     unschedule(job_id) if job_id 
 
@@ -744,11 +754,12 @@ module OpenWFE
                 # as a scheduler is fully transient, no need to
                 # have persistent ids, a simple counter is sufficient
 
-            attr_accessor \
-                :job_id, :tags, :block 
+            attr_accessor :job_id, :tags, :block 
+            attr_reader :scheduler
             
-            def initialize (job_id, tags, &block)
+            def initialize (scheduler, job_id, tags, &block)
 
+                @scheduler = scheduler
                 @block = block
 
                 if job_id
@@ -773,14 +784,21 @@ module OpenWFE
             def has_tag? (tag)
                 @tags.include?(tag)
             end
+
+            #
+            # Removes (cancels) this job from its scheduler.
+            #
+            def unschedule
+                @scheduler.unschedule(@job_id)
+            end
         end
 
         class AtJob < Job
 
             attr_accessor :at
 
-            def initialize (at, at_id, tags, &block)
-                super(at_id, tags, &block)
+            def initialize (scheduler, at, at_id, tags, &block)
+                super(scheduler, at_id, tags, &block)
                 @at = at
             end
 
@@ -796,9 +814,9 @@ module OpenWFE
 
             attr_accessor :cron_line
 
-            def initialize (cron_id, line, tags, &block)
+            def initialize (scheduler, cron_id, line, tags, &block)
 
-                super(cron_id, tags, &block)
+                super(scheduler, cron_id, tags, &block)
 
                 if line.kind_of?(String)
                     @cron_line = CronLine.new(line)

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: openwferu-scheduler
 version: !ruby/object:Gem::Version 
-  version: 0.9.15.1127
+  version: 0.9.15.1128
 date: 2007-10-07 00:00:00 +09:00
 summary: OpenWFEru scheduler for Ruby (at, cron and every)
 require_paths: