pub struct RdmResponder<D: DmxReceiver + RdmControllerDriver, const MQ_SIZE: usize> { /* private fields */ }
Expand description
The structure to build an RDM Receiver. MQ_SIZE specifies the size of the message queue and the status vector. MQ_SIZE cannot be greater than 255.
Implementations§
Source§impl<D: DmxReceiver + RdmControllerDriver, const MQ_SIZE: usize> RdmResponder<D, MQ_SIZE>
impl<D: DmxReceiver + RdmControllerDriver, const MQ_SIZE: usize> RdmResponder<D, MQ_SIZE>
Sourcepub fn new(driver: D, config: RdmResponderConfig) -> Self
pub fn new(driver: D, config: RdmResponderConfig) -> Self
Creates a new RdmResponder.
Sourcepub fn poll<HandlerError>(
&mut self,
handler: &mut dyn DmxResponderHandler<Error = HandlerError>,
) -> Result<bool, PollingError<D::DriverError, HandlerError>>
pub fn poll<HandlerError>( &mut self, handler: &mut dyn DmxResponderHandler<Error = HandlerError>, ) -> Result<bool, PollingError<D::DriverError, HandlerError>>
Call this function as often as you can or on a serial interrupt. It will receive a package and handle it.
Returns false if no package was received.
Sourcepub fn get_message_queue(&self) -> &Deque<RdmResponseData, MQ_SIZE>
pub fn get_message_queue(&self) -> &Deque<RdmResponseData, MQ_SIZE>
Get the message queue that contains the results of RdmResult::AcknowledgedTimer packages.
Sourcepub fn get_message_queue_mut(&mut self) -> &mut Deque<RdmResponseData, MQ_SIZE>
pub fn get_message_queue_mut(&mut self) -> &mut Deque<RdmResponseData, MQ_SIZE>
Get the message queue to add the results of RdmResult::AcknowledgedTimer packages to.
Sourcepub fn get_message_count(&self) -> u8
pub fn get_message_count(&self) -> u8
Get the amount of queued messages.
Sourcepub fn get_status_vec(&self) -> &Vec<StatusMessage, MQ_SIZE>
pub fn get_status_vec(&self) -> &Vec<StatusMessage, MQ_SIZE>
Get the status queue that contains the current status messages.
Sourcepub fn get_status_vec_mut(&mut self) -> &mut Vec<StatusMessage, MQ_SIZE>
pub fn get_status_vec_mut(&mut self) -> &mut Vec<StatusMessage, MQ_SIZE>
Get the status queue to add or remove status messages.
Auto Trait Implementations§
impl<D, const MQ_SIZE: usize> Freeze for RdmResponder<D, MQ_SIZE>where
D: Freeze,
impl<D, const MQ_SIZE: usize> RefUnwindSafe for RdmResponder<D, MQ_SIZE>where
D: RefUnwindSafe,
impl<D, const MQ_SIZE: usize> Send for RdmResponder<D, MQ_SIZE>where
D: Send,
impl<D, const MQ_SIZE: usize> Sync for RdmResponder<D, MQ_SIZE>where
D: Sync,
impl<D, const MQ_SIZE: usize> Unpin for RdmResponder<D, MQ_SIZE>where
D: Unpin,
impl<D, const MQ_SIZE: usize> UnwindSafe for RdmResponder<D, MQ_SIZE>where
D: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more