Struct IpcChannel 

pub struct IpcChannel { /* private fields */ }

IPC channel — a buffered Unix socket pair endpoint that speaks newline-delimited JSON, optionally carrying a RawFd per message via SCM_RIGHTS ancillary data.

One channel = one endpoint of a socketpair(AF_UNIX, SOCK_STREAM). The other endpoint belongs to the peer (parent ↔ child).

Implementations

impl IpcChannel

pub fn new(socket: UnixStream) -> IpcChannel

Wrap an existing connected UnixStream as an IPC channel endpoint.

pub fn send_json(&mut self, json: &str) -> Result<(), Error>

Send a JSON message terminated by \n. No fd is attached.

pub fn send_handle(&mut self, json: &str, fd: i32) -> Result<(), Error>

Send a JSON message + fd via SCM_RIGHTS ancillary data.

The fd is duplicated into the kernel’s ancillary buffer; the receiver obtains a new independent fd via recvmsg. The kernel-level fd remains valid in the sender until the sender closes it (we do NOT close it here — the caller may still need it).

pub fn recv_msg(&mut self) -> Result<(String, Option<i32>), Error>

Receive the next JSON message (blocking read until a newline-terminated line is available, or until a SCM_RIGHTS recvmsg delivers a complete payload). Returns (json, Option<fd>) — the fd, if present, was carried by the SCM_RIGHTS ancillary data of one of the recvmsg calls that produced this message.

Returns an UnexpectedEof error when the peer has closed the channel and the buffer is drained. is_connected() will return false afterwards.

pub fn is_connected(&self) -> bool

Returns true while neither side has closed the channel.

pub fn close(&mut self)

Close the underlying socket. Safe to call multiple times.

pub fn raw_fd(&self) -> i32

Borrow the underlying socket fd (for epoll registration etc.).

Trait Implementations

impl Drop for IpcChannel

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.