Struct IpcSocket 

pub struct IpcSocket { /* private fields */ }

An exclusively owned, bound Unix-domain IPC socket.

The advisory lock file serializes daemon startup so two processes can never both decide that the socket is stale. The guard removes the socket on drop, but only when the path still refers to the exact inode created by this instance, so a successor’s socket is never unlinked.

Implementations

impl IpcSocket

pub async fn acquire<P: AsRef<Path>>(path: P) -> Result<Self, IpcError>

Acquires the socket path and binds a listener.

A live socket is reported as IpcError::AlreadyRunning. A stale socket (connection refused) is removed and replaced. Any other kind of filesystem object at the path is left untouched and rejected.

pub fn path(&self) -> &Path

pub async fn serve<F, Fut>(self, handler: F) -> Result<(), IpcError>

where F: Fn(IpcCommand) -> Fut + Send + Sync + 'static, Fut: Future<Output = IpcResponse> + Send + 'static,

Serves IPC connections until the listener fails.

At most [MAX_CONCURRENT_CONNECTIONS] connections are handled at once. Accepting is gated by the semaphore, so a flood backpressures in the kernel backlog instead of allocating unbounded tasks.

pub fn spawn<F, Fut>(self, handler: F)

where F: Fn(IpcCommand) -> Fut + Send + Sync + 'static, Fut: Future<Output = IpcResponse> + Send + 'static,

Runs IpcSocket::serve on a detached task.

impl IpcSocket

pub fn identity(&self) -> IpcSocketIdentity

Trait Implementations

impl Drop for IpcSocket

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.