Struct ChannelPool

pub struct ChannelPool { /* private fields */ }

Self-managed pool of tonic’s Channels.

Implementations

impl ChannelPool

pub async fn get_channel(&self) -> Option<(IpAddr, Channel)>

Get a channel from the pool.

This function will return a channel if one is available, or None if no channels are available.

Selection algorithm

Currently, the channel is selected randomly from the pool of available channels. However, this behavior may change in the future.

Additional DNS and broken connection checks

If no channels are available, the function will check the DNS and recheck connections to all servers currently marked as dead. To avoid spamming the DNS and other servers, this will be performed no more than once every 500ms.

If the above check is running while this function is called, the function will wait for the check to finish and return the result.

If the check is not running, but the last check was performed less than 500ms ago, the function will return None immediately.

The specifics of this behavior are not set in stone and may change in the future.

pub async fn report_broken(&self, ip_address: impl Into<IpAddr>)

Report a broken endpoint to the pool.

This function will remove the endpoint from the pool and add it to the list of currently dead servers.

Trait Implementations

impl Clone for ChannelPool

This is a shallow clone, meaning that the new pool will reference the same resources as the original pool.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelPool

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

Formats the value using the given formatter.