commit	43f7901ac6952720a6fa31aacab247d4c86a2513	[log] [tgz]
author	Jeff Vander Stoep <jeffv@google.com>	Fri Oct 16 09:26:55 2020 +0000
committer	Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>	Fri Oct 16 09:26:55 2020 +0000
tree	06387a99197895704c1163958f6a8551e9798983
parent	57e139965937009092e0e4a0a2118659f08a447a [diff]
parent	dbbce4ec9529e125d066a639307be1d38fb15345 [diff]

tree: 06387a99197895704c1163958f6a8551e9798983

README.md

gRPC-rs

gRPC-rs is a Rust wrapper of gRPC Core. gRPC is a high performance, open source universal RPC framework that puts mobile and HTTP/2 first.

Status

This project is still under development. The following features with the check marks are supported:

[x] Basic asynchronous unary/steaming call
[x] SSL
[x] Generic call
[x] Connection level compression
[x] Interoperability test
[x] QPS benchmark
[ ] Custom metadata
[x] Health check
[ ] Reflection
[X] Authentication
[ ] Load balance, client side is fully supported, server side load report is not implemented yet.

Prerequisites

CMake >= 3.8.0
Rust >= 1.36.0
binutils >= 2.22
LLVM and Clang >= 3.9 if you need to generate bindings at compile time.
By default, the secure feature is provided by boringssl. You can also use openssl instead by enabling openssl feature.

For Linux and MacOS, you also need to install gcc (or clang) too.

Bindings are pre-generated for x86_64/arm64 Linux. For other platforms, bindings are generated at compile time.

For Windows, you also need to install following software:

Active State Perl
yasm
Visual Studio 2015+

Build

$ ./scripts/reset-submodule.cmd # if you just cloned the repository
$ cargo build

Error linking OpenSSL

If you're getting linker errors when building your project using gRPC-rs, head down to the openssl feature section for a possible fix.

Usage

To generate the sources from proto files:

Option 1 - Manual Generation

Install the protobuf compiler:

$ cargo install protobuf-codegen

Install the gRPC compiler:

$ cargo install grpcio-compiler

Generate the sources:

$ protoc --rust_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_rust_plugin` example.proto

Option 2 - Programmatic Generation

Programmatic generation can be used to generate Rust modules from proto files via your build.rs by using protoc-grpcio.

For more information and examples see README.

To include this project as a dependency:

[dependencies]
grpcio = "0.6"

Feature `secure`

secure feature enables support for TLS encryption and some authentication mechanism. When you do not need it, for example when working in intranet, you can disable it by using the following configuration:

[dependencies]
grpcio = { version = "0.6", default-features = false, features = ["protobuf-codec"] }

Feature `prost-codec` and `protobuf-codec`

gRPC-rs uses protobuf crate by default. If you want to use prost instead, you can enable prost-codec feature. You probably only want to enable only one of the two features. Though grpcio is completely fine with both features enabled at the same time, grpcio-compiler will not going to work as expected.

Feature `openssl` and `openssl-vendored`

gRPC-rs comes vendored with gRPC Core, which by default uses BoringSSL instead of OpenSSL. This may cause linking issues due to symbol clashes and/or missing symbols when another one of your dependencies uses OpenSSL. To resolve this, you can tell gRPC-rs to use OpenSSL too by specifying "openssl" in your Cargo.toml's features list for gprcio, which requires openssl (>=1.0.2). E.g.:

[dependencies]
grpcio = { version = "0.6", features = ["openssl"] }

Feature openssl-vendored is the same as feature openssl except it will build openssl from bundled sources.

Performance

See benchmark to find out how to run a benchmark by yourself.

Cross Compile

See cross_compile

Contributing

Make sure to format and test the code before sending a PR.

If the content in grpc-sys/grpc is updated, you may need to regenerate bindings:

$ ./scripts/generate-bindings.sh