Struct OverlaydClient 

pub struct OverlaydClient { /* private fields */ }

A connected overlayd client.

Implementations

impl OverlaydClient

pub async fn connect(endpoint: &Path) -> Result<Self>

Connect once to the overlayd endpoint.

Errors

Propagates the underlying connect error.

pub async fn connect_with_backoff(endpoint: &Path) -> Result<Self>

Connect with exponential backoff (100ms → 1s, ~20 attempts) so the main daemon can start before overlayd has finished binding its socket.

Use this on the path that has just spawned overlayd and legitimately needs to wait for it to bind (the supervisor). On hot paths where a dead overlayd must degrade fast (overlay setup is non-fatal), prefer Self::connect_with_attempts with a small budget so daemon startup is not held hostage by an unreachable overlayd.

Errors

Returns the last connect error if every attempt fails.

pub async fn connect_with_attempts( endpoint: &Path, max_attempts: u32, ) -> Result<Self>

Connect with bounded exponential backoff (100ms → 1s) for at most max_attempts attempts. Sleeps only between attempts (never after the final one), so the worst-case wall time for a dead endpoint is bounded and predictable: max_attempts = 6 ≈ 100+200+400+800+1000 = ~2.5s.

Errors

Returns the last connect error if every attempt fails.

pub fn endpoint(&self) -> &Path

The endpoint this client is connected to.

pub async fn request( &mut self, request: OverlaydRequest, ) -> Result<OverlaydResponse>

Send a request and await its matching response. Event frames that arrive while waiting are logged and skipped (a request/response client does not subscribe to events).

Errors

Propagates transport errors. The returned OverlaydResponse may itself be OverlaydResponse::Err; use Self::call to fold that into an error.

pub async fn call( &mut self, request: OverlaydRequest, ) -> Result<OverlaydResponse>

Like Self::request but maps an Err response into OverlaydError::Overlay, so callers get a single Result.

Errors

Transport errors, or OverlaydError::Overlay if overlayd returned an error response.