Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hyperium/tonic

A native gRPC client & server implementation with async/await support.
https://github.com/hyperium/tonic

async grpc proto rpc rust

Last synced: 3 days ago
JSON representation

A native gRPC client & server implementation with async/await support.

Awesome Lists containing this project

README 

        
![](https://github.com/hyperium/tonic/raw/master/.github/assets/tonic-banner.svg?sanitize=true)



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.



[![Crates.io](https://img.shields.io/crates/v/tonic)](https://crates.io/crates/tonic)

[![Documentation](https://docs.rs/tonic/badge.svg)](https://docs.rs/tonic)

[![Crates.io](https://img.shields.io/crates/l/tonic)](LICENSE)



[Examples] | [Website] | [Docs] | [Chat][discord]



## 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 by [`rustls`]

- Load balancing

- Custom metadata

- Authentication

- Health Checking



## Getting Started



Examples can be found in [`examples`] and for more complex scenarios [`interop`]

may be a good resource as it shows examples of many of the gRPC features.



### Rust Version



`tonic`'s MSRV is `1.71.1`.



### Dependencies



[`tonic-build`] uses `protoc` [Protocol Buffers compiler] in some APIs which compile Protocol Buffers resource files such as [`tonic_build::compile_protos()`].



[Protocol Buffers compiler]: https://protobuf.dev/downloads/

[`tonic_build::compile_protos()`]: https://docs.rs/tonic-build/latest/tonic_build/fn.compile_protos.html



### Tutorials



- The [`helloworld`][helloworld-tutorial] tutorial provides a basic example of using `tonic`, perfect for first time users!

- The [`routeguide`][routeguide-tutorial] tutorial provides a complete example of using `tonic` and 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][discord]. We would be happy to try to answer your

question. If that doesn't work, try opening an [issue] with the question.



[issue]: https://github.com/hyperium/tonic/issues/new/choose



## Project Layout



- [`tonic`]: Generic gRPC and HTTP/2 client/server implementation.

- [`tonic-build`]: [`prost`] based service codegen.

- [`tonic-types`]: [`prost`] based grpc utility types including support for gRPC Well Known Types.

- [`tonic-health`]: Implementation of the standard [gRPC health checking service][healthcheck].

  Also serves as an example of both unary and response streaming.

- [`tonic-reflection`]: A tonic based gRPC reflection implementation.

- [`examples`]: Example gRPC implementations showing off tls, load balancing and bi-directional streaming.

- [`interop`]: Interop tests implementation.



## Contributing



:balloon: Thanks for your help improving the project! We are so happy to have

you! We have a [contributing guide][guide] to help you get involved in the Tonic

project.



[guide]: CONTRIBUTING.md



## License



This project is licensed under the [MIT license](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.



[gRPC]: https://grpc.io

[`tonic`]: ./tonic

[`tonic-build`]: ./tonic-build

[`tonic-types`]: ./tonic-types

[`tonic-health`]: ./tonic-health

[`tonic-reflection`]: ./tonic-reflection

[`examples`]: ./examples

[`interop`]: ./interop

[`tokio`]: https://github.com/tokio-rs/tokio

[`hyper`]: https://github.com/hyperium/hyper

[`prost`]: https://github.com/tokio-rs/prost

[`protobuf`]: https://protobuf.dev/

[`rustls`]: https://github.com/rustls/rustls

[`interop`]: https://github.com/hyperium/tonic/tree/master/interop

[Examples]: https://github.com/hyperium/tonic/tree/master/examples

[Website]: https://github.com/hyperium/tonic

[Docs]: https://docs.rs/tonic

[discord]: https://discord.gg/6yGkFeN

[routeguide-tutorial]: https://github.com/hyperium/tonic/blob/master/examples/routeguide-tutorial.md

[helloworld-tutorial]: https://github.com/hyperium/tonic/blob/master/examples/helloworld-tutorial.md

[healthcheck]: https://grpc.io/docs/guides/health-checking/