rzmq 0.5.23

High performance, CPU and memory efficient, fully asynchronous, safe pure-Rust implementation of ZeroMQ (ØMQ) messaging with io_uring and TCP Cork acceleration on Linux.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Type aliases for actor communication channels.

use crate::runtime::command::Command;
use fibre::mpsc;

/// Default capacity for bounded mailboxes created by the `mailbox()` helper function.
/// This capacity applies to the single mailbox used by `SocketCore` and other simpler actors.
/// It can be tuned based on expected load and performance characteristics.
pub const DEFAULT_MAILBOX_CAPACITY: usize = 256;

/// The async sending end of an actor's mailbox.
/// Used by Tokio tasks to send commands to `SocketCore`.
pub type MailboxSender = mpsc::BoundedAsyncSender<Command>;

/// The sync sending end of an actor's mailbox.
/// Used by OS threads (e.g. the io_uring worker) to send commands to `SocketCore` across the sync/async boundary.
pub type MailboxSyncSender = mpsc::BoundedSyncSender<Command>;

/// The receiving end of an actor's mailbox.
/// Only one task should typically own and receive from a `MailboxReceiver` to process commands sequentially.
pub type MailboxReceiver = mpsc::BoundedAsyncReceiver<Command>;

/// Creates a new single bounded mailbox channel pair.
/// This is the standard way to create mailboxes for actors in this system, including `SocketCore`.
///
/// # Returns
/// A tuple containing the `MailboxSender` and `MailboxReceiver`.
pub fn mailbox(capacity: usize) -> (MailboxSender, MailboxReceiver) {
  mpsc::bounded_async(capacity.max(1))
}