James Steele
b02b4b238b
* fix(build): Prevent duplicated client/server generated code The tonic-build process collects up RPC services as they are provided by prost, before writing them out as part of the finalization step for a given protocol buffer package. In the case of imported protocol buffer packages, there may be RPC services included by import in addition to those in the top-level package. Therefore it is necessary to make sure each set of client/server services gathered by tonic-build is cleared after the finalization process for a given protocol buffer package, otherwise they will be incorrectly aggregated as the generation process proceeds through the subsequent packages. * Test case for duplicated client/server generated code A simple test case that will fail to build without a fix to prevent RPC services being duplicated into inappropriate modules (that related to particular protocol buffer packages). * Additional test case for included_service Introduces an additional case that captures making sure services defined before including a package with additional services doesn't incidentially clear such precursor services from the including package. * Fix unnecessary newline to keep `cargo fmt` happy
A rust implementation of gRPC, a high performance, open source, general RPC framework that puts mobile and HTTP/2 first.
tonic is a gRPC over HTTP/2 implementation focused on high performance, interoperability, and flexibility. This library was created to have first class support of async/await and to act as a core building block for production systems written in Rust.
Examples | Website | Docs | Chat
Overview
tonic is composed of three main components: the generic gRPC implementation, the high performance HTTP/2
implementation and the codegen powered by prost. The generic implementation can support any HTTP/2
implementation and any encoding via a set of generic traits. The HTTP/2 implementation is based on hyper,
a fast HTTP/1.1 and HTTP/2 client and server built on top of the robust tokio stack. The codegen
contains the tools to build clients and servers from protobuf definitions.
Features
- Bi-directional streaming
- High performance async io
- Interoperability
- TLS backed via either
opensslorrustls - Load balancing
- Custom metadata
- Authentication
Getting Started
Examples can be found in tonic-examples and for more complex scenarios tonic-interop
may be a good resource as it shows examples of many of the gRPC features.
Rust Version
tonic currently works on rust 1.39 and above as it requires support for the async_await
feature.
$ rustup update
$ rustup component add rustfmt
$ cargo build
Tutorials
- The
helloworldtutorial provides a basic example of usingtonic, perfect for first time users! - The
routeguidetutorial provides a complete example of usingtonicand all its features.
Getting Help
First, see if the answer to your question can be found in the API documentation. If the answer is not there, there is an active community in the Tonic Discord channel. We would be happy to try to answer your question. If that doesn't work, try opening an issue with the question.
Project Layout
tonic: Generic gRPC and HTTP/2 client/server implementation.tonic-build:prostbased service codegen.tonic-examples: Example gRPC implementations showing off tls, load balancing and bi-directional streaming.tonic-interop: Interop tests implementation.
Contributing
🎈 Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the Tonic project.
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tonic by you, shall be licensed as MIT, without any additional terms or conditions.