Struct IPCConnection 

pub struct IPCConnection { /* private fields */ }

A connection between an IPC client and server.

Connections are used to exchange data using Execute, Request, Poke, and Advise operations. The connection can be created by the server (in OnAcceptConnection) or returned from a client’s MakeConnection call.

Implementations

impl IPCConnection

pub fn builder() -> IPCConnectionBuilder

Create a new connection builder.

pub fn execute(&self, data: &[u8], format: IPCFormat) -> bool

Execute a command on the remote side.

On the server side, this triggers the client’s OnExecute callback. On the client side, this triggers the server’s OnExecute callback.

pub fn execute_string(&self, data: &str) -> bool

Execute a string command (convenience method for text data).

pub fn request(&self, item: &str, format: IPCFormat) -> Option<Vec<u8>>

Request data from the remote side.

Returns the data if the request was successful, None otherwise.

pub fn poke(&self, item: &str, data: &[u8], format: IPCFormat) -> bool

Poke data to the remote side.

pub fn start_advise(&self, item: &str) -> bool

Start an advise loop for the given item.

The server will send updates via the OnAdvise callback when the item changes.

pub fn stop_advise(&self, item: &str) -> bool

Stop an advise loop for the given item.

pub fn advise(&self, item: &str, data: &[u8], format: IPCFormat) -> bool

Send advised data to the client (server-side only).

pub fn disconnect(&self) -> bool

Disconnect the connection.

pub fn is_connected(&self) -> bool

Check if the connection is still connected.

Trait Implementations

impl Drop for IPCConnection

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.