A simple Redis-based task queue
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
.gitignore
.travis.yml
Cargo.toml
LICENSE
Makefile
README.md

README.md

oppgave - A simple Redis-based task queue

crates.io Build Status

Inspired by Ost and Kute.

A small reliable queue on top of Redis. Allows to push tasks and fetch them again. Can handle whatever task object you hand it, as long as it can be encoded and decoded to and from JSON.

The name: oppgave - task

oppgave is Norwegian for task. So oppgave is a oppgave kø, a task queue.

Sadly, characters like ø don't play to well with stable Rust. Non-ASCII identifiers are feature-gated.

It would be possible with nightly and the non_ascii_idents feature to use oppgave-kø, but crates.io doesn't accept crates with non-ascii characters in the name. :(

Documentation

Documentation is available online.

Installation

Add it to your dependencies in Cargo.toml

[dependencies]
oppgave = "0.1.0"

Example: Producer

See examples/worker.rs for a working example. Run it with cargo run --example worker.

#[derive(RustcDecodable, RustcEncodable)]
struct Job { id: u64 }

let client = redis::Client::open("redis://127.0.0.1/").unwrap();
let con = client.get_connection().unwrap();
let producer = Queue::new("default".into(), con);

producer.push(Job{ id: 42 });

Example: Worker

See examples/worker.rs for a working example. Run it with cargo run --example worker.

#[derive(RustcDecodable, RustcEncodable)]
struct Job { id: u64 }

let client = redis::Client::open("redis://127.0.0.1/").unwrap();
let con = client.get_connection().unwrap();
let worker = Queue::new("default".into(), con);

while let Some(task) = worker.next() {
    println!("Working with Job {}", job.id);
}

License

MIT. See LICENSE.