Struct message_plugins::std_runtime::Host

pub struct Host<T> {
    pub tasks: Vec<JoinHandle<Option<u8>>>,
    // some fields omitted
}

Meant as the main way of sending commands to plugins. A structure that holds the input ends of the queues to each plugin, as well as the JoinHandles to their tasks.

Fields

tasks: Vec<JoinHandle<Option<u8>>>

Implementations

impl<T: Sync + Send + 'static> Host<T>

pub fn new() -> Self

pub const DEFAULT_CHANNEL_CAPACITY: usize

By default, plugins will communicate with the host using a queue capable of holding this many Messages.

pub fn send(&mut self, message: impl Into<Message<T>>)

Sends a message to all the attached Plugins.

pub fn attach(&mut self, plugin: impl Plugin<T>)

Enables a Plugin by attaching it to the Host: a channel is built, the input is given to the host; a task running the Plugin's handle_message method on every Message sent over the channel is spawned, and the JoinHandle to this task is added to the host's handles.

pub fn attach_with_capacity(&mut self, plugin: impl Plugin<T>, capacity: usize)

Like attach, but allows you to choose your own channel capacity.

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

Drops every channel end, closing them, then waits for all plugins to finish processing the remaining messages.

Trait Implementations

impl<T> Drop for Host<T>

fn drop(&mut self)

Executes the destructor for this type.