Jobs

Job Scheduling In C++ Made Easy.

Jobs is a library that provides an easy to use API that lets you schedule C++ functions to run at a specified time(s) using a human readable syntax.

Contents

• Getting Started
• Functionality
• Examples

Getting Started

Jobs uses bake as its build system. bake makes it easy to build Jobs and link it to any project on your computer. For details on how to use bake see bake's github repository.

Using Jobs with your project:

First, clone the Jobs repository using:

git clone --recursive https://github.com/yuvaldolev/Jobs

Then, Add to following line to your project.json under the value key:

"use": ["Jobs"]

Last, To build and link Jobs run:

bake

• If both projects' directories (Jobs, and the project that uses it) are in the same directory, then all you need to do is run bake in the root directory.
• If not, you need to run bake in Jobs' directory, and then run bake in the dependent project's directory.

Functionality

The following functions are available in Jobs:

Job Scheduling Functions:

Function	Description
Every(interval: int)	Schedules a new job with the given interval
Second()	Makes the job run every second
Seconds()	Makes the job run every interval seconds
Minute()	Make the job run every minute
Minutes()	Makes the job run every interval minutes
Hour()	Makes the job run every hour
Hours()	Makes the job run every interval hours
Day()	Makes the job run every day
Days()	Makes the job run every interval days
Week()	Makes the job run every week
Weeks()	Makes the job run every interval weeks
Sunday()	Makes the job run every Sunday
Monday()	Makes the job run every Monday
Tuesday()	Makes the job run every Tuesday
Wednesday()	Makes the job run every Wednesday
Thursday()	Makes the job run every Thursday
Friday()	Makes the job run every Friday
Saturday()	Makes the job run every Saturday
At()	Makes the job at a specific time (for example - 10:30:22)
To(latest: int)	Makes the job run in a random time in range: interval - latest
Do(jobFunc: std::function<void(void)>)	Specifies the job function that will be called every time the job runs

Job Running Functions:

Function	Description
Run()	Starts the job run loop
RunAsync()	Starts the job run loop asynchronously
Stop()	Stops the job run loop
RunPending()	Runs all the pending jobs once
RunAll()	Runs all the jobs once

Job Management Functions:

Function	Description
Clear()	Cancels and removes all the jobs
CancelJob(job: Job*)	Cancels and removes a specific job

Job Info Functions:

Function	Description
NextRun()	Returns a string that date and time when the next job should run
IdleSeconds()	Returns the number of seconds until the next run

Job Querying Functions:

Function	Description
FindJob(fn: std::function<void(void)>	Finds a running job and returns a pointer to it

Changing Existing Job's Properties:

Function	Description
RunEvery(interval: int)	Changes an existing's interval

Examples

Running jobs synchronously:

void PrintHello()
{
    std::cout << "Hello World" << std::endl;
}

int main()
{
    Jobs::Every(5).Seconds().Do(BIND_FN(PrintHello));
    Jobs::Run();
    return 0;
}

Running jobs asynchronously:

void PrintHi()
{
    std::cout << "Hi" << std::endl;
}

int main()
{
    Jobs::Every().Hour().Do(BIND_FN(PrintHi));
    Jobs::RunAsync();
    return 0;
}

Different examples of using the Jobs API:

// Seconds
Jobs::Every().Second().Do(BIND_FN(func));
Jobs::Every(23).Seconds().Do(BIND_FN(func));

// Minutes
Jobs::Every().Minute().Do(BIND_FN(func));
Jobs::Every(4).Minutes().Do(BIND_FN_func));

// Hours
Jobs::Every().Hour().Do(BIND_FN(func));
Jobs::Every(18).Hours().Do(BIND_FN(func));

// Days
Jobs::Every().Day().Do(BIND_FN(func));
Jobs::Every(2).Days().Do(BIND_FN(func));

// Weeks
Jobs::Every().Week().Do(BIND_FN(func));
Jobs::Every(6).Weeks().Do(BIND_FN(func));

// Week Days
Jobs::Every().Monday().Do(BIND_FN(func));
Jobs::Every().Friday().Do(BIND_FN(func));

// Specific Times
Jobs::Every().Day().At("12:45").Do(BIND_FN(func));
Jobs::Every().Tuesday().At("18:01:58").Do(BIND_FN(func));
Jobs::Every().Hour().At("10").Do(BIND_FN(func)); // Specific minute every hour
Jobs::Every(7).Minutes().At("25").Do(BIND_FN(func)); // Specific second every 7 minutes

// Random Time In Range
Jobs::Every(5).To(7).Minutes().Do(BIND_FN(func));
Jobs::Every(6).To(12).Days().Do(BIND_FN(func));