Background Jobs
This crate provides tooling required to run some processes asynchronously from a usually synchronous application. The standard example of this is Web Services, where certain things need to be processed, but processing them while a user is waiting for their browser to respond might not be the best experience.
Usage
Add Background Jobs to your project
[]
= "2.2.0"
= "0.15.0"
= { = "1.0", = ["derive"] }
To get started with Background Jobs, first you should define a job.
Jobs are a combination of the data required to perform an operation, and the logic of that
operation. They implement the Job
, serde::Serialize
, and serde::DeserializeOwned
.
use ;
use ;
The run method for a job takes an additional argument, which is the state the job expects to use. The state for all jobs defined in an application must be the same. By default, the state is an empty tuple, but it's likely you'll want to pass in some Actix address, or something else.
Let's re-define the job to care about some application state.
Running jobs
By default, this crate ships with the background-jobs-actix
feature enabled. This uses the
background-jobs-actix
crate to spin up a Server and Workers, and provides a mechanism for
spawning new jobs.
background-jobs-actix
on it's own doesn't have a mechanism for storing worker state. This
can be implemented manually by implementing the Storage
trait from background-jobs-core
,
or the provided in-memory store can be used.
With that out of the way, back to the examples:
Main
use ;
async
Complete Example
For the complete example project, see the examples folder
Bringing your own server/worker implementation
If you want to create your own jobs processor based on this idea, you can depend on the
background-jobs-core
crate, which provides the Job trait, as well as some
other useful types for implementing a jobs processor and job store.
Contributing
Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3.
License
Copyright © 2022 Riley Trautman
background-jobs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
background-jobs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of background-jobs.
You should have received a copy of the GNU General Public License along with background-jobs. If not, see http://www.gnu.org/licenses/.