Skip to main content

WorkerClientPool

Struct WorkerClientPool 

Source
pub struct WorkerClientPool { /* private fields */ }
Expand description

Connection pool for WorkerClient instances.

Caches authenticated gRPC channels by worker address, avoiding the overhead of re-establishing connections and re-authenticating for every block I/O. Matches Java’s FileSystemContext.acquireBlockWorkerClient() pattern.

The pool is thread-safe and can be shared across concurrent workers.

§Single-Flight Reconnect

When a SASL stream silently expires server-side, many concurrent RPCs on the same cached channel will fail simultaneously with UNAUTHENTICATED. Without coordination each observer would independently invoke reconnect, producing a “thundering herd” that serialises through the pool’s write lock and wastes CPU/RTT on duplicate TCP+SASL handshakes.

To collapse this herd, each WorkerClient carries a monotonic generation tag. Callers pass the observed generation back into reconnect_if_stale after an auth failure; only the first observer of a given generation actually performs the reconnect, all other concurrent observers receive the already-replaced client. This reduces N concurrent reconnects to exactly 1.

Implementations§

Source§

impl WorkerClientPool

Source

pub fn new(config: GoosefsConfig) -> Self

Create a new empty connection pool.

Source

pub async fn acquire(&self, addr: &str) -> Result<WorkerClient>

Acquire a WorkerClient for the given address.

Returns a cached client if one exists, otherwise creates a new connection. The tonic Channel supports multiplexing, so a single cached client can handle multiple concurrent RPCs.

Source

pub async fn invalidate(&self, addr: &str)

Remove a worker from the pool (e.g., after a connection failure).

The next acquire() call for this address will create a fresh connection.

Source

pub async fn reconnect_if_stale( &self, addr: &str, stale_generation: u64, ) -> Result<WorkerClient>

Single-flight reconnect: invalidate + reconnect only if the currently cached client’s generation still matches stale_generation.

This is the preferred recovery path on authentication failure. The caller passes the generation() of the client that just failed; because every WorkerClient carries a unique monotonic generation allocated by this pool:

  • If another concurrent task has already reconnected in response to the same underlying SASL expiry, the cached generation will have advanced past stale_generation and this call returns the already-replaced client without performing another TCP+SASL handshake.
  • Otherwise, this call performs exactly one reconnect under the per-address mutex.

Net effect: N concurrent AuthenticationFailed observers on the same channel trigger exactly one reconnect instead of N.

Source

pub async fn reconnect(&self, addr: &str) -> Result<WorkerClient>

Invalidate a cached worker connection and immediately reconnect.

Prefer reconnect_if_stale whenever the caller holds a reference to the failing WorkerClient — it deduplicates concurrent reconnects triggered by the same underlying SASL expiry.

This unconditional variant is kept for paths where the caller does not know the generation of the failing client (e.g. a stand-alone connect() failure that never produced a WorkerClient). It acquires the same per-address reconnect mutex so it still coalesces against any in-flight reconnect_if_stale.

Source

pub fn new_shared(config: GoosefsConfig) -> Arc<Self>

Create a new pool wrapped in Arc for shared ownership.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more