Struct ipc_channel::router::ROUTER

pub struct ROUTER {
    __private_field: (),
}

Global object wrapping a RouterProxy. Add routes (add_route), or convert IpcReceiver to crossbeam channels (e.g. route_ipc_receiver_to_new_crossbeam_receiver)

Fields

__private_field: ()

Methods from Deref<Target = RouterProxy>

pub fn add_route(&self, receiver: OpaqueIpcReceiver, callback: RouterHandler)

👎Deprecated since 0.19.0: please use ‘add_typed_route’ instead

Add a new (receiver, callback) pair to the router, and send a wakeup message to the router.

Consider using add_typed_route instead, which prevents mismatches between the receiver and callback types.

pub fn add_typed_route<T>( &self, receiver: IpcReceiver<T>, callback: TypedRouterHandler<T>, )

where T: Serialize + for<'de> Deserialize<'de> + 'static,

Add a new (receiver, callback) pair to the router, and send a wakeup message to the router.

Unlike add_route this method is strongly typed and guarantees that the receiver and the callback use the same message type.

pub fn shutdown(&self)

Send a shutdown message to the router containing a ACK sender, send a wakeup message to the router, and block on the ACK. Calling it is idempotent, which can be useful when running a multi-process system in single-process mode.

pub fn route_ipc_receiver_to_crossbeam_sender<T>( &self, ipc_receiver: IpcReceiver<T>, crossbeam_sender: Sender<T>, )

where T: for<'de> Deserialize<'de> + Serialize + Send + 'static,

A convenience function to route an IpcReceiver<T> to an existing Sender<T>.

pub fn route_ipc_receiver_to_new_crossbeam_receiver<T>( &self, ipc_receiver: IpcReceiver<T>, ) -> Receiver<T>

where T: for<'de> Deserialize<'de> + Serialize + Send + 'static,

A convenience function to route an IpcReceiver<T> to a Receiver<T>: the most common use of a Router.

Trait Implementations

impl Deref for ROUTER

type Target = RouterProxy

The resulting type after dereferencing.

fn deref(&self) -> &RouterProxy

Dereferences the value.

impl LazyStatic for ROUTER