Struct tonic::transport::channel::Channel

pub struct Channel { /* fields omitted */ }

A default batteries included transport channel.

This provides a fully featured http2 gRPC client based on [hyper::Client] and tower services.

Multiplexing requests

Sending a request on a channel requires a &mut self and thus can only send on request in flight. This is intentional and is required to follow the Service contract from the tower library which this channel implementation is built on top of.

tower itself has a concept of poll_ready which is the main mechanism to apply back pressure. poll_ready takes a &mut self and when it returns Poll::Ready we know the Service is able to accept only one request before we must poll_ready again. Due to this fact any async fn that wants to poll for readiness and submit the request must have a &mut self reference.

To work around this and to ease the use of the channel, Channel provides a Clone implementation that is cheap. This is because at the very top level the channel is backed by a tower_buffer::Buffer which runs the connection in a background task and provides a mpsc channel interface. Due to this cloning the Channel type is cheap and encouraged.

Methods

impl Channel

pub fn builder(uri: Uri) -> Endpoint

Create a [Endpoint] builder that can create a [Channel]'s.

pub fn from_static(s: &'static str) -> Endpoint

Create an Endpoint from a static string.

Channel::from_static("https://example.com");

pub fn from_shared(s: impl Into<Bytes>) -> Result<Endpoint, InvalidUri>

Create an Endpoint from shared bytes.

Channel::from_shared("https://example.com");

pub fn balance_list(list: impl Iterator<Item = Endpoint>) -> Self

Balance a list of [Endpoint]'s.

This creates a [Channel] that will load balance accross all the provided endpoints.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Channel

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl GrpcService<BoxBody> for Channel

type ResponseBody = Body

Responses body given by the service.

type Error = Error

Errors produced by the service.

type Future = ResponseFuture

The future response value.

fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), Self::Error>>

Returns Ready when the service is able to process requests.

fn call(&mut self, request: Request<BoxBody>) -> Self::Future

Process the request and return the response asynchronously.