Struct hid_io_core::mailbox::Mailbox

pub struct Mailbox {
    pub nodes: Arc<RwLock<Vec<Endpoint>>>,
    pub last_uid: Arc<RwLock<u64>>,
    pub lookup: Arc<RwLock<HashMap<String, Vec<u64>>>>,
    pub sender: Sender<Message>,
    pub ack_timeout: Arc<RwLock<Duration>>,
    pub rt: Arc<Runtime>,
}

HID-IO Mailbox

Handles passing messages to various components inside of HID-IO Best thought of as a broadcast style packet switcher. Each thread (usually async tokio) is given a receiver and can filter for any desired packets. This is not quite as effecient as direct channels; however, this greatly simplifies message passing across HID-IO. Making it easier to add new modules.

This struct can be safely cloned and passed around anywhere in the codebase. In most cases only the sender field is used (as it has the subscribe() function as well).

Fields

nodes: Arc<RwLock<Vec<Endpoint>>>

last_uid: Arc<RwLock<u64>>

lookup: Arc<RwLock<HashMap<String, Vec<u64>>>>

sender: Sender<Message>

ack_timeout: Arc<RwLock<Duration>>

rt: Arc<Runtime>

Implementations

impl Mailbox

pub fn new(rt: Arc<Runtime>) -> Mailbox

pub fn get_uid(&mut self, key: String, path: String) -> Option<u64>

Attempt to locate an unused id for the device key

pub fn add_uid(&mut self, key: String, uid: u64)

Add uid to lookup

pub fn assign_uid(&mut self, key: String, path: String) -> Result<u64, Error>

Assign uid This function will attempt to lookup an existing id first And generate a new uid if necessary An error is returned if this lookup already has a uid (string+path)

pub fn register_node(&mut self, endpoint: Endpoint)

Register node as an endpoint (device or api)

pub fn unregister_node(&mut self, uid: u64)

Unregister node as an endpoint (device or api)

pub async fn send_command(
    &self,
    src: Address,
    dst: Address,
    id: HidIoCommandId,
    data: Vec<u8>,
    ack: bool
) -> Result<Option<Message>, AckWaitError>

Convenience function to send a HidIo Command to device using the mailbox Returns the Ack message if enabled. Ack will timeout if it exceeds self.ack_timeout

pub fn try_send_message(
    &self,
    msg: Message
) -> Result<Option<Message>, CommandError>

Convenience function to send a HidIoPacketBuffer using the mailbox Returns the Ack message if available and applicable

pub fn try_send_command(
    &self,
    src: Address,
    dst: Address,
    id: HidIoCommandId,
    data: Vec<u8>,
    ack: bool
) -> Result<Option<Message>, AckWaitError>

Convenience function to send a HidIo Command to device using the mailbox Returns the Ack message if enabled. This is the blocking version of send_command(). Ack will timeout if it exceeds self.ack_timeout

pub fn drop_subscriber(&self, uid: u64, sid: u64)

pub fn drop_all_subscribers(&self)

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Mailbox

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Mailbox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Mailbox

fn default() -> Self

Returns the “default value” for a type.