README
¶
Ya3s - Yet another super simplistic scheduler
This is a work in progress to provide a simple way of scheduling stand alone functions to run at a specific point in time.
Example
import (
"fmt"
"github.com/oskar-r/ya3s"
)
func testFunc() error {
//execute a task
fmt.Printf("Task executed")
return nil
}
func testFunc2() error {
//execute a task
fmt.Printf("Task executed")
return nil
}
func main() {
//Set up the task scheduler
ya3s.Setup()
//Add task to run every minute
ya3s.AddTask(testFunc, "* * * *")
//Add task to run every tenth minute
ya3s.AddTask(testFunc2, "0,10,20,30,40,50 * * *")
}
At this point in time you must your self secure that the task can execute within the timeframe for the task
Todo
- Dependencies between tasks scheduled to run
- REST interface to query the task scheduler for status and running tasks
Documentation
¶
Overview ¶
Package ya3s - Yet Another Super Simple Scheduler is a task schedule tkat executed tasks on assigned interval based on a cron syntax
At the begning of each minute assess if any task is up for execution, if so the task is executed and reports back execution statis to the task que. Tasks need to contain all logic needed to execute them and should only return an error
Copyright (C) 2019 by Oskar Roman <roman.oskar@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddTask ¶
AddTask add a new task to the que for execution once in the defined schedule (cron style * * * *)
func ListRegisteredTasks ¶
func ListRegisteredTasks()
ListRegisteredTasks returns task and status for all currently registered tasks
Source Files