Struct GracefulIpcChannel 

pub struct GracefulIpcChannel<T = Vec<u8>> { /* private fields */ }

IPC channel with graceful shutdown support

Implementations

impl<T> GracefulIpcChannel<T>

pub fn new(channel: IpcChannel<T>) -> Self

Create a new graceful IPC channel wrapper

pub fn with_state(channel: IpcChannel<T>, state: Arc<ShutdownState>) -> Self

Create a new graceful IPC channel with a shared shutdown state

pub fn create(name: &str) -> Result<Self>

Create a new IPC channel server with graceful shutdown

pub fn connect(name: &str) -> Result<Self>

Connect to an existing IPC channel with graceful shutdown

pub fn name(&self) -> &str

Get the channel name

pub fn is_server(&self) -> bool

Check if this is the server end

pub fn wait_for_client(&mut self) -> Result<()>

Wait for a client to connect (server only)

pub fn state(&self) -> Arc<ShutdownState>

Get the shutdown state for sharing with other channels

pub fn inner(&self) -> &IpcChannel<T>

Get a reference to the inner channel

pub fn inner_mut(&mut self) -> &mut IpcChannel<T>

Get a mutable reference to the inner channel

pub fn bind_affinity_thread(&self)

Bind the current thread as the affinity thread for this channel’s reentrancy-safe dispatch queue.

Call this once on the “main” (or named) thread that will drive pump_pending.

pub fn submit_reentrant<F, R>(&self, f: F) -> Result<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Submit f to run on the bound affinity thread in a deadlock-free way.

• Caller is the affinity thread → f executes inline.
• Any other thread → f is queued; the caller blocks until pump_pending processes it.

Parallel to Swift’s MainActor.assumeIsolated and C#’s SynchronizationContext.Send.

Errors

Returns IpcError::Closed if the channel has been shut down or the affinity thread has been dropped.

pub fn pump_pending(&self, budget: Duration) -> usize

Drain at most budget of pending work items on the current thread.

Call this from your host’s idle callback (Maya scriptJob idleEvent, Unity EditorApplication.update, Unreal FTSTicker, Blender bpy.app.timers, etc.) to let cross-thread submissions complete.

Returns the number of items processed.

impl GracefulIpcChannel<Vec<u8>>

pub fn send_bytes(&mut self, data: &[u8]) -> Result<()>

Send raw bytes

pub fn recv_bytes(&mut self) -> Result<Vec<u8>>

Receive raw bytes

impl<T: Serialize + DeserializeOwned> GracefulIpcChannel<T>

pub fn send(&mut self, msg: &T) -> Result<()>

Send a typed message (serialized as JSON)

pub fn recv(&mut self) -> Result<T>

Receive a typed message (deserialized from JSON)

Trait Implementations

impl<T> GracefulChannel for GracefulIpcChannel<T>

fn shutdown(&self)

Signal the channel to shutdown

fn is_shutdown(&self) -> bool

Check if the channel has been signaled to shutdown

fn drain(&self) -> Result<()>

Wait for all pending messages to be processed

fn shutdown_timeout(&self, timeout: Duration) -> Result<()>

Shutdown with a timeout