1.8.0-beta.1

Author: DoumanAsh

.github/workflows/rust.yml

@@ -48,4 +48,4 @@ jobs:
       run: cargo check
 
     - name: Test
-      run: cargo test --features http,tls
+      run: cargo test --features http,tls --release

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nng-c"
-version = "1.8.0"
+version = "1.8.0-beta.1"
 authors = ["Douman <[email protected]>"]
 edition = "2018"
 keywords = ["nng", "nanomsg"]

README.md

@@ -11,4 +11,61 @@ Version corresponds to C library
 ## Features
 
 - `http` - Enables http transport
+- `tls` - Enables TLS transport
+- `websocket` - Enables websocket transport. Implies `http` feature.
 - `log` - Enables logging via [log](https://crates.io/crates/log) crate
+
+## Usage
+
+Basic example of client and server communication
+
+```rust
+use nng_c::{options, Socket, Message, ErrorCode};
+
+use core::time;
+
+//Feel free to append zero char to avoid unnecessary allocations
+const ADDR: &str = "ipc://nng-c-example\0";
+const REQ_TIMEOUT: options::Req = options::Req {
+     resend_time: Some(time::Duration::from_millis(50)),
+     resend_tick: Some(time::Duration::from_millis(1)),
+};
+
+fn server() -> Result<(), ErrorCode> {
+    let server = Socket::rep0()?;
+    server.listen(ADDR.into()).expect("listen");
+
+    loop {
+        let msg = server.recv_msg()?;
+        let body = msg.body();
+        let msg = core::str::from_utf8(body).expect("utf-8 bytes");
+        match msg {
+            "quit" => break Ok(()),
+            other => {
+                println!("Received bytes(len={})={:?}", other.len(), other);
+            }
+        }
+    }
+}
+
+let server = std::thread::spawn(server);
+
+//Wait for thread to spin
+std::thread::sleep(time::Duration::from_millis(10));
+
+let client = Socket::req0().expect("Create client");
+client.set_opt(REQ_TIMEOUT).expect("Set options");
+
+client.connect(ADDR.into()).expect("connect");
+
+let mut msg = Message::new().expect("create message");
+msg.append("ping".as_bytes()).expect("Input bytes");
+client.send_msg(msg).expect("send message");
+
+let mut msg = Message::new().expect("create message");
+msg.append("quit".as_bytes()).expect("Input bytes");
+client.send_msg(msg).expect("send quit");
+
+server.join().expect("Finish server successfully");
+
+```

src/lib.rs

@@ -1,4 +1,67 @@
 //!High level bindings to the lib nng
+//!
+//!Version corresponds to C library
+//!
+//!## Features
+//!
+//!- `http` - Enables http transport
+//!- `tls` - Enables TLS transport
+//!- `websocket` - Enables websocket transport. Implies `http` feature.
+//!- `log` - Enables logging via [log](https://crates.io/crates/log) crate
+//!
+//!## Usage
+//!
+//!Basic example of client and server communication
+//!
+//!```rust
+//!use nng_c::{options, Socket, Message, ErrorCode};
+//!
+//!use core::time;
+//!
+//!//Feel free to append zero char to avoid unnecessary allocations
+//!const ADDR: &str = "ipc://nng-c-example\0";
+//!const REQ_TIMEOUT: options::Req = options::Req {
+//!     resend_time: Some(time::Duration::from_millis(50)),
+//!     resend_tick: Some(time::Duration::from_millis(1)),
+//!};
+//!
+//!fn server() -> Result<(), ErrorCode> {
+//!    let server = Socket::rep0()?;
+//!    server.listen(ADDR.into()).expect("listen");
+//!
+//!    loop {
+//!        let msg = server.recv_msg()?;
+//!        let body = msg.body();
+//!        let msg = core::str::from_utf8(body).expect("utf-8 bytes");
+//!        match msg {
+//!            "quit" => break Ok(()),
+//!            other => {
+//!                println!("Received bytes(len={})={:?}", other.len(), other);
+//!            }
+//!        }
+//!    }
+//!}
+//!
+//!let server = std::thread::spawn(server);
+//!
+//!//Wait for thread to spin
+//!std::thread::sleep(time::Duration::from_millis(10));
+//!
+//!let client = Socket::req0().expect("Create client");
+//!client.set_opt(REQ_TIMEOUT).expect("Set options");
+//!
+//!client.connect(ADDR.into()).expect("connect");
+//!
+//!let mut msg = Message::new().expect("create message");
+//!msg.append("ping".as_bytes()).expect("Input bytes");
+//!client.send_msg(msg).expect("send message");
+//!
+//!let mut msg = Message::new().expect("create message");
+//!msg.append("quit".as_bytes()).expect("Input bytes");
+//!client.send_msg(msg).expect("send quit");
+//!
+//!server.join().expect("Finish server successfully");
+//!```
 
 #![no_std]
 #![warn(missing_docs)]