https://github.com/badboy/oppgave

A simple Redis-based task queue
https://github.com/badboy/oppgave

Last synced: 9 days ago
JSON representation

A simple Redis-based task queue

• Host: GitHub
• URL: https://github.com/badboy/oppgave
• Owner: badboy
• License: mit
• Created: 2016-02-14T18:17:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-31T18:57:40.000Z (almost 6 years ago)
• Last Synced: 2024-12-24T02:01:31.199Z (12 days ago)
• Language: Rust
• Homepage: http://badboy.github.io/oppgave/
• Size: 1.62 MB
• Stars: 43
• Watchers: 5
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# oppgave - A simple Redis-based task queue

[![crates.io](http://meritbadge.herokuapp.com/oppgave)](https://crates.io/crates/oppgave)

[![Build Status](https://travis-ci.org/badboy/oppgave.svg?branch=master)](https://travis-ci.org/badboy/oppgave)

Inspired by [Ost](https://github.com/soveran/ost) and [Kute](https://github.com/moonglum/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](https://github.com/rust-lang/rust/issues/28979).

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.][documentation]

[documentation]: https://docs.rs/oppgave/

## Installation

Add it to your dependencies in `Cargo.toml`

```toml

[dependencies]

oppgave = "0.1.0"

```

## Example: Producer

See [`examples/worker.rs`](examples/worker.rs) for a working example.

Run it with `cargo run --example worker`.

```rust

#[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`](examples/worker.rs) for a working example.

Run it with `cargo run --example worker`.

```rust

#[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](LICENSE).