7642e5af98
* fix(scheduler): data race when pushing new tasks the problem here is that scheduler can be closed in two ways: - canceling the context given as argument to scheduler.RunScheduler() - running scheduler.Shutdown() because of this shutdown can trigger a data race between calling scheduler.inShutdown() and actually pushing tasks into the pool workers solved that by keeping a quit channel and listening on both quit channel and ctx.Done() and closing the worker chan and scheduler afterwards. Signed-off-by: Petu Eusebiu <peusebiu@cisco.com> * refactor(scheduler): refactor into a single shutdown before this we could stop scheduler either by closing the context provided to RunScheduler(ctx) or by running Shutdown(). simplify things by getting rid of the external context in RunScheduler(). keep an internal context in the scheduler itself and pass it down to all tasks. Signed-off-by: Petu Eusebiu <peusebiu@cisco.com> --------- Signed-off-by: Petu Eusebiu <peusebiu@cisco.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| scheduler.go | ||
| scheduler_test.go | ||
How to submit a Generator to the scheduler
What is a generator and how should it be implemented?
In order to create a new generator (which will generate new tasks one by one) and add it to the scheduler there are 4 methods which should be implemented:
- Next() (Task, error)
This method should implement the logic for generating a new task. Basically, when this method is called by the scheduler it should return the next task until there are no more tasks to be generated. Also, the Task returned by this method should implement DoWork(ctx context.Context) method which should contain the logic that should be executed when this task is run by the scheduler. - IsDone() bool
This method should return true after the generator finished all the work and has no more tasks to generate. - IsReady() bool
This method should return true if the generator is ready to generate a new task and should be used when it is needed to generate tasks with some delay between. - Reset()
When this method is called the generator should reset to its initial state. After the generator is reset, it will generate new tasks as if it hadn't been used before. This is useful for periodic generators, because the scheduler will call this method when the generator is done and has to wait a specific interval of time for this generator to become ready to run again.
Submit a generator
The scheduler accepts both periodic and non-periodic generators.
To submit a generator to the scheduler, SubmitGenerator should be called with the implemented generator, interval of time (which should be time.Duration(0) in case of non-periodic generator, or the interval for the periodic generator) and the priority of the tasks which will be generated by this generator as parameters.
Notes:
- A generator should submit only tasks having the same priority
- The priority of a task can be: LowPriority, MediumPriority or HighPriority
How to submit a Task to the scheduler
In order to create a new task and add it to the scheduler we need to implement below methods:
- DoWork(ctx context.Context) error
This should contain the logic that should be executed when this task is run by the scheduler.
- Name() string
Name of the task.
- String() string
Description of the task. Used in debugging to identify executed task.
To submit a task to the scheduler SubmitTask should be called with the implemented task and the priority of the task as parameters.
Note:
- A task can not be periodic. In order to add a periodic task, it can be created a generator which will generate periodically the same task.