Struct AimDbHandle 

pub struct AimDbHandle { /* private fields */ }

Handle to the AimDB runtime thread.

Created by calling AimDb::attach(). Provides factory methods for creating typed producers and consumers.

Thread Safety

AimDbHandle is Send + Sync and can be shared across threads. However, it should typically be owned by one thread, with only the producers/consumers being cloned and shared.

Resource Management

Call detach() explicitly to ensure clean shutdown. If the handle is dropped without calling detach(), a warning will be logged and an emergency shutdown will be attempted.

Implementations

impl AimDbHandle

pub fn producer<T>(&self) -> DbResult<SyncProducer<T>>

where T: Send + 'static + Debug + Clone,

Create a synchronous producer for type T.

Type Parameters

• T: The record type, must implement TypedRecord

Errors

• DbError::RecordNotFound if type T was not registered
• DbError::RuntimeShutdown if the runtime thread has stopped

Example

let producer = handle.producer::<Temperature>()?;
producer.set(Temperature { celsius: 25.0 })?;

pub fn consumer<T>(&self) -> DbResult<SyncConsumer<T>>

where T: Send + Sync + 'static + Debug + Clone,

Create a synchronous consumer for type T.

Type Parameters

• T: The record type, must implement TypedRecord

Errors

• DbError::RecordNotFound if type T was not registered
• DbError::RuntimeShutdown if the runtime thread has stopped

Example

let consumer = handle.consumer::<Temperature>()?;
let temp = consumer.get()?;

pub fn producer_with_capacity<T>( &self, capacity: usize, ) -> DbResult<SyncProducer<T>>

where T: Send + 'static + Debug + Clone,

Create a synchronous producer with custom channel capacity.

Like producer() but allows specifying the channel buffer size. Use this when you need different buffering characteristics for specific record types.

Arguments

• capacity: Channel buffer size (number of items that can be buffered)

Type Parameters

• T: The record type, must implement TypedRecord

Errors

• DbError::RecordNotFound if type T was not registered
• DbError::RuntimeShutdown if the runtime thread has stopped

Example

// High-frequency sensor needs larger buffer
let producer = handle.producer_with_capacity::<HighFrequencySensor>(1000)?;
producer.set(HighFrequencySensor { value: 42.0 })?;

pub fn consumer_with_capacity<T>( &self, capacity: usize, ) -> DbResult<SyncConsumer<T>>

where T: Send + Sync + 'static + Debug + Clone,

Create a synchronous consumer with custom channel capacity.

Like consumer() but allows specifying the channel buffer size. Use this when you need different buffering characteristics for specific record types.

Arguments

• capacity: Channel buffer size (number of items that can be buffered)

Type Parameters

• T: The record type, must implement TypedRecord

Errors

• DbError::RecordNotFound if type T was not registered
• DbError::RuntimeShutdown if the runtime thread has stopped

Example

// Rare events need smaller buffer
let consumer = handle.consumer_with_capacity::<RareEvent>(10)?;
let event = consumer.get()?;

pub fn detach(self) -> DbResult<()>

Gracefully shut down the runtime thread.

Signals the runtime to stop, waits for all pending operations to complete, then joins the thread. This is the preferred way to shut down.

Errors

• DbError::DetachFailed if shutdown fails or times out

Example

handle.detach()?;

pub fn detach_timeout(self, timeout: Duration) -> DbResult<()>

Gracefully shut down with a timeout.

Like detach(), but fails if shutdown takes longer than the specified duration.

Arguments

• timeout: Maximum time to wait for shutdown

Errors

• DbError::DetachFailed if shutdown fails or times out

Example

handle.detach_timeout(Duration::from_secs(5))?;

Trait Implementations

impl Drop for AimDbHandle

fn drop(&mut self)

Attempts graceful shutdown if detach() was not called.

Logs a warning and attempts shutdown with a 5-second timeout. If shutdown fails, the runtime thread may be left running.

impl Send for AimDbHandle

impl Sync for AimDbHandle