Skip to main content

PoolClient

Struct PoolClient 

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

A thin UDS client for communicating with a pool worker process.

Each PoolClient instance owns a single Unix domain socket connection to one worker. Messages are JSON lines (\n-terminated).

§Lifecycle

  1. Call PoolClient::connect — opens the socket and runs the version handshake atomically. If the handshake fails the connection is dropped and an error is returned; no PoolClient instance is produced.
  2. Call PoolClient::send_request for each message.
  3. Drop the PoolClient when done; the underlying socket is closed.

Implementations§

Source§

impl PoolClient

Source

pub async fn connect(sock_path: &Path) -> Result<Self, PoolError>

Open a connection to a worker at sock_path and verify protocol version.

The handshake (PoolRequest::Handshake) is performed inside this call. If the worker reports a different version, Err(PoolError::VersionMismatch) is returned and no PoolClient is constructed.

§Concurrency

Cancel safety: this function is not cancel safe. If dropped before recv_line completes, the internal BufReader may hold a partial line; the partial connection is dropped and must not be reused.

Timeout: the handshake recv is bounded by HANDSHAKE_RECV_TIMEOUT (10 s). If the worker does not respond within this window, the function returns Err(PoolError::Handshake("handshake recv timeout (10s)")) and the connection is dropped. This prevents RunningService::cancel from hanging when a worker fails to send the handshake.

Send + Sync: PoolClient is Send (all fields are Send). It is not Sync — callers sharing across tasks must wrap in Arc<tokio::sync::Mutex<PoolClient>>.

§Errors
  • PoolError::Connect — socket connect failed (wraps std::io::Error).
  • PoolError::Handshake — response could not be parsed as valid JSON, or the handshake recv timed out after 10 s.
  • PoolError::VersionMismatch — worker version differs from client version.
Source

pub async fn send_request( &mut self, req: PoolRequest, ) -> Result<PoolResponse, PoolError>

Send a PoolRequest over the Unix domain socket and await the response.

Serialises the request to a JSON line (\n-terminated), writes it via tokio::io::AsyncWriteExt::write_all, then reads the response with tokio::io::AsyncBufReadExt::read_line.

§Concurrency

Cancel safety: this function is not cancel safe. AsyncBufReadExt::read_line is not cancel safe per tokio documentation: if this future is dropped before read_line completes, the internal buffer may hold a partial line. After cancellation the connection is no longer usable; callers must drop this PoolClient and reconnect.

Mutex serialisation: the internal tokio::sync::Mutex<Inner> serialises concurrent callers. Cancelling a lock().await call loses queue position (tokio docs: “Cancelling a call to lock makes you lose your place in the queue”). Only one request can be in-flight per PoolClient instance at a time. Holding the guard across .await (write + flush + read_line) is intentional and correct with tokio::sync::Mutex.

Send + Sync: PoolClient is Send (all fields are Send). It is not Sync — callers sharing across tasks must wrap in Arc<tokio::sync::Mutex<PoolClient>>.

§Panics

Does not panic.

Trait Implementations§

Source§

impl Debug for PoolClient

Source§

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

Formats the value using the given formatter. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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
Source§

impl<T> MaybeSend for T
where T: Send,