Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alex179ohm/nsq-client-rs

NSQ client written in rust
https://github.com/alex179ohm/nsq-client-rs

actix crate nsq nsq-client rust rust-crate rust-nsq rustlang

Last synced: 29 days ago
JSON representation

NSQ client written in rust

Awesome Lists containing this project

README

        

# NSQ client written in rust [![Build Status](https://travis-ci.com/alex179ohm/nsq-client-rs.svg?branch=master)](https://travis-ci.com/alex179ohm/nsq-client-rs) [![Build status](https://ci.appveyor.com/api/projects/status/ov5ryj2r4iy2v7rp/branch/master?svg=true)](https://ci.appveyor.com/project/alex179ohm/nsq-client-rs/branch/master) [![](https://img.shields.io/crates/v/nsq-client.svg?style=flat)](https://crates.io/crates/nsq-client)

Sponsored by
---
A [Actix](https://actix.rs/) based client implementation for the [NSQ](https://nsq.io) realtime message processing system.

Nsq-client it's designed to support by default multiple Readers for Multiple Connections, readers are routed per single connection by a round robin algorithm.
## Usage

To use nsq-client, add this to your Cargo.toml:
```toml
[dependencies]
actix = "0.7"
nsq-client = "0.1.12"
```
### Create your first consumer
In order to use nsq-client you first need to create a Reader actor which implement Handler for the type of messages you want to receive
from the connections and then subscribe it to the connections to be able to receive the type of messages you've selected.

Available messages are:
- [Msg](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.Msg.html)
- [InFlight](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.InFlight.html)
- [OnIdentify](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.OnIdentify.html)
- [OnAuth](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.OnAuth.html)
- [OnClose](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.OnClose.html)
- [OnBackoff](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.OnBackoff.html)
- [OnResume](https://docs.rs/nsq-client/0.1.11/nsq_client/struct.OnResume.html)

### Simple Consumer (SUB)
```rust
extern crate actix;
extern crate nsq_client;

use std::sync::Arc;

use actix::prelude::*;

use nsq_client::{Connection, Msg, Fin, Subscribe, Config};

struct MyReader {
pub conn: Arc>,
}

impl Actor for MyReader {
type Context = Context;
fn started(&mut self, ctx: &mut Self::Context) {
self.subscribe::(ctx, self.conn.clone());
}
}

impl Handler for MyReader {
fn handle(&mut self, msg: Msg, _: &mut Self::Context) {
println!("MyReader received {:?}", msg);
if let Ok(body) = String::from_utf8(msg.body) {
println!("utf8 msg: {}", body);
}
self.conn.do_send(Fin(msg.id));
}
}

fn main() {
let sys = System::new("consumer");
let config = Config::default().client_id("consumer");
let c = Supervisor::start(|_| Connection::new(
"test", // <- topic
"test", // <- channel
"0.0.0.0:4150", // <- nsqd tcp address
Some(config), // <- config (Optional)
None, // secret for Auth (Optional)
Some(2) // <- RDY (Optional default: 1)
));
let conn = Arc::new(c);
let _ = MyReader{ conn: conn.clone() }.start(); // <- Same thread reader
let _ = Arbiter::start(|_| MyReader{ conn: conn }); // <- start another reader in different thread
sys.run();
}
```
### launch nsqd
```bash
$ nsqd -verbose
```
### launch the reader
```bash
$ RUST_LOG=nsq_client=debug cargo run
```
### launch the producer
```bash
$ cargo run
```

[![asciicast](https://asciinema.org/a/8dZ5QgjN3WCwDhgU8mAX9BMsR.svg)](https://asciinema.org/a/8dZ5QgjN3WCwDhgU8mAX9BMsR)

## Examples
- [Simple Processing Message](https://github.com/alex179ohm/nsq-client-rs/tree/master/examples/reader)
- [Simple Producer](https://github.com/alex179ohm/nsq-client-rs/tree/master/examples/producer)

### ToDo
- [ ] Discovery
- [ ] TLS
- [ ] Snappy
- [ ] First-ready-first-served readers routing algorithm.

## License

Licensed under
* MIT license (see [LICENSE](LICENSE) or )