Skip to main content

PersistentIpcClientHandle

Struct PersistentIpcClientHandle 

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

Handle to a persistent IPC client that maintains a long-lived connection to the headless sidecar.

The background task automatically:

  • Relays IpcEvent frames to app.emit("background-service://event", ...)
  • Reconnects on connection failure with exponential backoff (1s–30s, up to 10 retries)
  • Forwards commands (start/stop/is_running) over the same connection

Implementations§

Source§

impl PersistentIpcClientHandle

Source

pub fn spawn<R: Runtime>(socket_path: PathBuf, app: AppHandle<R>) -> Self

Spawn the persistent IPC client background task.

The task immediately begins trying to connect to the socket at socket_path. Events are relayed to the Tauri event system via app.emit().

Source

pub async fn start(&self, config: StartConfig) -> Result<(), ServiceError>

Send a Start command through the persistent connection.

Source

pub async fn stop(&self) -> Result<(), ServiceError>

Send a Stop command through the persistent connection.

Source

pub async fn is_running(&self) -> Result<bool, ServiceError>

Query whether the service is running through the persistent connection.

Source

pub async fn get_state(&self) -> Result<ServiceStatus, ServiceError>

Query the current service lifecycle state through the persistent connection.

Source

pub fn is_connected(&self) -> bool

Returns true if the persistent client is currently connected to the headless sidecar, false otherwise.

Trait Implementations§

Source§

impl Drop for PersistentIpcClientHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. 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, 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