Commits

David Hessing  committed e575385

Minor doc and comment clarifications.

  • Participants
  • Parent commits f354663

Comments (0)

Files changed (2)

 1. **schedule** - Whenever Iron Scheduler runs it uses this value to decide whether or not to queue the scheduled task. This value is a regular expression that is matched against the Date object UTC string. [This](http://www.debuggex.com/) page is extremely helpful in contructing regex strings that give you the matches you want. Don't forget to escape the backslashes when you put it into the JSON. *Required.*
 1. **expires** - A date UTC string specifying until when Iron Scheduler should attempt to schedule this scheduled task. *Optional.*
 1. **number** - When the schedule matches, this value specifies how many of the specified tasks to queue up. *Required.*
-1. **interval** - When the schedule matches, this value specifices how long of an interval (in seconds) there should be between each of the jobs specified by the **number** parameter. So for example, if **number** is 3 and **interval** is 20, Iron Schedule will queue three tasks, the first one with a delay of 0, the second with a delay of 20 and the third with a delay of 40. *Required.*
+1. **interval** - When the schedule matches, this value specifies how long of an interval (in seconds) there should be between each of the tasks that will be queued. So for example, if **number** is 3 and **interval** is 20, Iron Schedule will queue three tasks, the first one with a delay of 0, the second with a delay of 20 and the third with a delay of 40. *Optional.*
 1. **task** - Details of the actual task to queue. *Required.*
 
     1. **code_name** - The name of the task to queue. Must match the name that's in ironio. *Required.*
 ## Current Limitations / Future Work ##
 
 * If a scheduled task is expired Iron Scheduler currently bombs (on purpose). Not sure what the correct logic should be.
-* If **interval** is set to 0 then it is treated as 1. This means that if **number** is greater than 1, the queued tasks won't be scheduled to be perfectly concurrent.
-* Right now each queued task is it's own API call, but the ironio API supports queueing multiple tasks in one call.
+* If **interval** is omitted or set to 0 then it is treated as 1. This means that if **number** is greater than 1, the queued tasks won't be scheduled to be perfectly concurrent; rather each will have a delay of (n-1) seconds.
+* Right now each queued task is its own API call, but the ironio API supports queueing multiple tasks in one call.
 
 ## License ##
 
             }
         }
         
-        //TODO: this is a hack, since if the interval is left off or is explicitly set to zero then this does create a (one * nth) second delay for each task.
-        //This will need to be fixed in order to support launching n concurrent tasks.
+        //If the interval is omitted or is explicitly set to zero then this will create a (one * (n-1)) second delay for each of the n tasks.
+        //TODO: This will need to be fixed in order to support launching n tasks perfectly concurrently.
         if (!interval || interval < 1) { interval = 1; }
 
         logger.debug('Now: %s schedRegEx: %s', nowStr, scheduledTask.schedule);