Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanolusardi/task_scheduler
Small & Simple Task Scheduler for C++17
https://github.com/stefanolusardi/task_scheduler
cmake continuous-integration cpp17 cross-platform examples header-only no-dependencies task-pool task-scheduler unit-test
Last synced: 21 days ago
JSON representation
Small & Simple Task Scheduler for C++17
- Host: GitHub
- URL: https://github.com/stefanolusardi/task_scheduler
- Owner: StefanoLusardi
- License: mit
- Created: 2020-09-15T07:40:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T23:39:30.000Z (almost 2 years ago)
- Last Synced: 2024-11-10T02:56:00.315Z (3 months ago)
- Topics: cmake, continuous-integration, cpp17, cross-platform, examples, header-only, no-dependencies, task-pool, task-scheduler, unit-test
- Language: C++
- Homepage:
- Size: 336 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssTs: Small & Simple Task Scheduler for C++17
**ssTs** is a time-based *Task Scheduler*, written in modern C++.
Header only, with [no external dependencies](#tests).
[Try **ssTs** out on Wandbox!](https://wandbox.org/permlink/yTJVogjpcsZzzyNq)
[](https://github.com/StefanoLusardi/task_scheduler/blob/master/LICENSE)
[](https://github.com/StefanoLusardi/task_scheduler/issues)
[](https://wandbox.org/permlink/yTJVogjpcsZzzyNq)
[](https://lgtm.com/projects/g/StefanoLusardi/task_scheduler/alerts/)
[](https://lgtm.com/projects/g/StefanoLusardi/task_scheduler/context:cpp)
[](https://www.codacy.com/manual/StefanoLusardi/task_scheduler/dashboard?utm_source=github.com&utm_medium=referral&utm_content=StefanoLusardi/task_scheduler&utm_campaign=Badge_Grade)
[](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
[](https://codecov.io/gh/StefanoLusardi/task_scheduler)
[](https://www.codacy.com/gh/StefanoLusardi/task_scheduler/dashboard?utm_source=github.com&utm_medium=referral&utm_content=StefanoLusardi/task_scheduler&utm_campaign=Badge_Coverage)
[](https://task-scheduler.readthedocs.io/en/latest/?badge=latest)
[](https://codedocs.xyz/StefanoLusardi/task_scheduler/)
- [Integration](#integration)
- [Header only](#header-only)
- [CMake](#cmake)
- [Supported OS and Compilers](#supported-os-and-compilers)
- [Development platforms](#development-platforms)
- [CI platforms](#ci-platforms)
- [Basic Usage](#basic-usage)
- [Documentation](#documentation)
- [Examples](#examples)
- [Tests](#tests)
## Integration
### Header only
Copy the [include](/include) folder, that contains the 3 header files [task.hpp](/include/ssts/task.hpp), [task_pool.hpp](/include/ssts/task_pool.hpp) and [task_scheduler.hpp](/include/ssts/task_scheduler.hpp) within your project sources or set your include path to it and just build your code.
**ssTs** requires a *C++17* compiler.
### CMake
It is possible to *install* the library using:
```console
$ git clone https://github.com/stefanolusardi/task_scheduler.git
$ cd ssts && mkdir build && cd build
$ cmake -G -DCMAKE_BUILD_TYPE= -DSSTS_INSTALL_LIBRARY=True -DCMAKE_INSTALL_PREFIX= ..
$ cmake --build . --config --target install
```
## Supported OS and Compilers
### Development platforms
* Windows 10 - Visual Studio 2019
* Windows 10 - Clang 10.0
* Windows 10 - Clang 9.0
* Ubuntu 20.04 - GCC 9.3
* Ubuntu 20.04 - Clang 9.0
* Ubuntu 20.04 - Clang 10.0
### CI platforms
#### Linux
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - GCC 9.3
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 18.04 - GCC 9.3
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 18.04 - GCC 7.5
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 18.04 - GCC 8.4
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - GCC 7.5
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - GCC 8.4
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 18.04 - Clang 8.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 18.04 - Clang 9.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - Clang 8.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - Clang 9.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Ubuntu 20.04 - Clang 10.0
#### Windows
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Windows Server 2019 - Visual Studio 2019
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Windows Server 2016 - Visual Studio 2017
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Windows Server 2019 - Clang 10.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
Windows Server 2016 - Clang 10.0
#### MacOS
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Mojave 10.14 - Clang 10.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Mojave 10.14 - GCC 8.4
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Mojave 10.14 - GCC 9.3
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Catalina 10.15 - Clang 10.0
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Catalina 10.15 - GCC 8.4
* [](https://stefanolusardi.visualstudio.com/ssts/_build/latest?definitionId=16&branchName=master)
MacOS X Catalina 10.15 - GCC 9.3
## Basic Usage
* Running a task is as simple as:
```cpp
// Create a Task Scheduler instance
ts::task_scheduler s(2);
// Start Task Scheduler
s.start()
// Spawn a one-shot task in 5 seconds
s.in(5s, []{std::cout << "Hello!" << std::endl;});
```
* To retrieve a task result you can do:
```cpp
// Launch a task with parameters and wait for its return value
std::future f = s.at(std::chrono::steady_clock::now() + 2s,
[](auto x, auto y){
std::cout << "Input parameters: " << x << y << std::endl;
return x+1;
}, 42, "fourty-two");
std::cout << "Task result: " << f.get() << std::endl; // prints 43
```
* It's possible to start a task giving it a task id to be able to manipulate it later:
```cpp
// Check if a task is currently scheduled
// (i.e. already inserted in the scheduler)
s.is_scheduled("my_task_id"); // false
// Check if a task is currently enabled
// (i.e. inserted and allowed to execute, by default any task is enabled)
s.is_enabled("my_task_id"); // false
// Start a recursive task with a task id that is scheduled every second
s.every("my_task_id", 1s, [](auto p){std::cout << "Hello! " << p << std::endl;}, "some_task_parameter");
s.is_scheduled("my_task_id"); // true
s.is_enabled("my_task_id"); // true
// Disable "my_task_id"
s.set_enabled("my_task_id", false);
s.is_scheduled("my_task_id"); // true
s.is_enabled("my_task_id"); // false
// Remove "my_task_id"
s.remove_task("my_task_id"s);
s.is_scheduled("my_task_id"); // false
s.is_enabled("my_task_id"); // false
// Stop Task Scheduler (by default it's always properly stopped when it goes out of scope)
s.stop();
```
* Nested task creation and execution is also supported:
```cpp
s.every("parent_task_id", 1s,
[&s]{
std::cout << "Parent Task!" << std::endl;
s.in("inner_task_id", 100ms, []{ std::cout << "Child Task!" << std::endl; });
});
```
## Documentation
*Documentation* sources are located in the [docs](/docs) folder.
An online version of the latest docs can be found [here](https://task-scheduler.readthedocs.io/en/latest/).
Docs are automatically generated from source code at every commit using *Doxygen*, *Breathe* and *Sphinx* and are hosted on *Read The Docs*.
It is possible to build the docs from CMake (*Doxygen*, *Breathe* and *Sphinx* are required) using:
```console
$ git clone https://github.com/stefanolusardi/task_scheduler.git
$ cd ssts && mkdir build && cd build
$ cmake -G -DSSTS_BUILD_DOCS=True ..
$ cmake --build .
```
## Examples
*Examples* are located within the [examples](/examples) folder.
It is possible to build and install the *examples* using:
```console
$ git clone https://github.com/stefanolusardi/task_scheduler.git
$ cd ssts && mkdir build && cd build
$ cmake -G -DCMAKE_BUILD_TYPE= -DSSTS_BUILD_EXAMPLES=True -DSSTS_INSTALL_LIBRARY=True -DSSTS_INSTALL_EXAMPLES=True ..
$ cmake --build . --config
```
## Tests
*Tests* are located within the [tests](/tests) folder.
[GoogleTest](https://github.com/google/googletest) is the only 3rd party library used and it is required only to build the tests target.
It is integrated using [DownloadGoogleTest.cmake](/cmake/DownloadGoogleTest.cmake) script.
It is possible to build the *tests* using:
```console
$ git clone https://github.com/stefanolusardi/task_scheduler.git
$ cd ssts && mkdir build && cd build
$ cmake -G -DCMAKE_BUILD_TYPE= -DSSTS_BUILD_TESTS=True ..
$ cmake --build . --config
```