Merge pull request #35 from Tim-Zhang/async-server

Add async support

Author: Hui Zhu

.gitignore

@@ -6,5 +6,5 @@ Cargo.lock
 .vscode
 .idea
 *.o
-example/protocols/*.rs
-!example/protocols/mod.rs
+example/protocols/**/*.rs
+!example/protocols/**/mod.rs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ttrpc"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["The AntFin Kata Team <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"
@@ -17,11 +17,17 @@ libc = { version = "0.2.59", features = [ "extra_traits" ] }
 nix = "0.16.1"
 log = "0.4"
 byteorder = "1.3.2"
+async-trait = "0.1.31"
+
+tokio = { version = "0.2", features = ["rt-threaded", "sync", "uds", "stream", "macros", "io-util"] }
+futures = "0.3"
 
 [build-dependencies]
 protobuf-codegen-pure = "2.14.0"
 
 [features]
-default = ["protobuf-codec"]
+default = ["protobuf-codec", "sync"]
 protobuf-codec = ["protobuf"]
+async = []
+sync = []
 

README.md

@@ -52,18 +52,65 @@ fn main() {
 }
 ```
 
+# async/.await
+ttrpc-rust supports async/.await. By using async/.await you can reduce the overhead and resource consumption caused by threads.
+
+## Usage
+### 1. Generate codes in async version
+Currently we only support generating async codes by using protoc_rust_ttrpc
+
+```
+    protoc_rust_ttrpc::Codegen::new()
+        .out_dir("protocols/asynchronous")
+        .inputs(&protos)
+        .include("protocols/protos")
+        .rust_protobuf()
+        .customize(Customize {
+            async_all: true, // It's the key option.
+            ..Default::default()
+        })
+        .run()
+        .expect("Gen async codes failed.");
+```
+
+Provide customize option
+- `async_all`: generate async codes for both server and client
+- `async_server`: generate async codes for server
+- `async_client`: generate async codes for client
+
+> See more in `example/build.rs`
+
+### 2. Write your implemention in async/.await's way
+Please follow the guidlines in `example/async-server.rs` and `example/async-client.rs`
+
 # Run Examples
 1. Go to the directory
 
-    `$ cd ttrpc-rust/example`
+    ```
+    $ cd ttrpc-rust/example
+    ```
 
 2. Start the server
 
-    `$ cargo run --example server unix:///tmp/1`
+    ```
+    $ cargo run --example server
+    ```
+    or
+
+    ```
+    $ cargo run --example async-server
+    ```
 
 3. Start a client
 
-    `$ cargo run --example client /tmp/1`
+    ```
+    $ cargo run --example client
+    ```
+    or
+    ```
+    $ cargo run --example async-client
+    ```
+
 
 # Notes: the version of protobuf
 protobuf-codegen, ttrpc_rust_plugin and your code should use the same version protobuf.

compiler/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ttrpc-compiler"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2018"
 authors = ["The AntFin Kata Team <[email protected]>"]
 license = "Apache-2.0"