Struct CommandQueue 

pub struct CommandQueue<T> { /* private fields */ }

Non-blocking bounded command queue.

Provides safe, lock-free transfer of commands from the control thread to the audio signal thread via a bounded crossbeam channel.

Example

use rill_core::queues::CommandQueue;

let queue = CommandQueue::<i32>::new("test", 16);
queue.send(42).unwrap();
assert_eq!(queue.try_recv(), Ok(42));

Implementations

impl<T: Send + 'static> CommandQueue<T>

pub fn new(name: &str, capacity: usize) -> Self

Create a new bounded queue with the given capacity.

pub fn send(&self, value: T) -> Result<(), QueueError>

Try to send a value into the queue (from the control thread).

Errors

Returns QueueFull if the queue is at capacity, or ChannelDisconnected if the receiver has been dropped.

pub fn try_recv(&self) -> Result<T, QueueError>

Try to receive a value from the queue (from the signal thread).

Errors

Returns QueueEmpty if no value is available, or ChannelDisconnected if the sender has been dropped.

pub fn sender(&self) -> Sender<T>

Get a clone of the inner crossbeam sender.

pub fn receiver(&self) -> Receiver<T>

Get a clone of the inner crossbeam receiver.

pub fn name(&self) -> &str

Return the human-readable queue name.

pub fn capacity(&self) -> usize

Return the fixed capacity of the queue.

pub fn len(&self) -> usize

Return the number of elements currently in the queue.

pub fn is_empty(&self) -> bool

Return true if the queue is currently empty.

Trait Implementations

impl<T> Clone for CommandQueue<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Send + 'static> Debug for CommandQueue<T>

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

Formats the value using the given formatter.

impl TelemetryQueueExt for CommandQueue<Telemetry>

fn send_parameter( &self, port: PortId, parameter: ParameterId, value: f32, ) -> Result<(), QueueError>

Send a parameter value telemetry event.

fn send_signal( &self, node_id: NodeId, channel: usize, data: Vec<f32>, ) -> Result<(), QueueError>

Send a signal data telemetry event.

fn send_signal_with_sample_rate( &self, node_id: NodeId, channel: usize, data: Vec<f32>, sample_rate: f32, ) -> Result<(), QueueError>

Send a signal data telemetry event with explicit sample rate.

fn send_peak(&self, port: PortId, value: f32) -> Result<(), QueueError>

Send a peak value telemetry event.

fn send_peak_with_hold( &self, port: PortId, value: f32, hold_time_ms: u32, ) -> Result<(), QueueError>

Send a peak value telemetry event with hold time.

fn send_event( &self, source: &str, kind: &str, data: Vec<f32>, ) -> Result<(), QueueError>

Send an event telemetry event.

fn send_event_with_description( &self, source: &str, kind: &str, data: Vec<f32>, description: &str, ) -> Result<(), QueueError>

Send an event telemetry event with description.

fn send_violation( &self, component: &str, expected_ns: u64, actual_ns: u64, value: Option<f32>, ) -> Result<(), QueueError>

Send a micro-control violation telemetry event.