ginepro

Crates.ioginepro
lib.rsginepro
version0.8.1
sourcesrc
created_at2021-05-12 15:06:03.187331
updated_at2024-07-10 09:21:05.40336
descriptionA client-side gRPC channel implementation for tonic
homepage
repositoryhttps://github.com/TrueLayer/ginepro
max_upload_size
id396546
size75,806
Rust OSS (github:truelayer:rust-oss)

documentation

README

ginepro

ginepro provides client-side gRPC load-balancing out of the box by enriching tonic ‘s channel with periodic service discovery.

Crates.io Docs.rs CI Coverage Status

Overview

ginepro enriches tonic by periodically updating the list of servers that are available through a ServiceDiscovery interface that currently is implemented for DNS.

How to install

Add ginepro to your dependencies

cargo add ginepro

Getting started

The interface remains fairly the same as we implement all the logic for a drop-in replacement for tonic's Channel.

// Using the `LoadBalancedChannel`.
use ginepro::LoadBalancedChannel;
use ginepro::pb::tester_client::TesterClient;

// Build a load-balanced channel given a service name and a port.
let load_balanced_channel = LoadBalancedChannel::builder(
    ("my_hostname", 5000)
  )
  .channel()
  .await
  .expect("failed to construct LoadBalancedChannel");

// Initialise a new gRPC client for the `Test` service
// using the load-balanced channel as transport
let grpc_client = TesterClient::new(load_balanced_channel);

For more examples, have a look at the examples directory.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 41

cargo fmt