Struct canadensis_can::CanTransmitter

pub struct CanTransmitter<C, D> { /* private fields */ }

Splits outgoing transfers into frames

Implementations

impl<C, D> CanTransmitter<C, D>where C: Clock, D: TransmitDriver<C>,

pub fn new(mtu: Mtu) -> Self

Creates a transmitter

mtu: The maximum number of bytes in a frame

pub fn set_mtu(&mut self, mtu: Mtu)

Sets the MTU

This will take effect on the next call to push().

pub fn transfer_count(&self) -> u64

Returns the number of transfers successfully transmitted

Success means that the frames were placed into the frame queue successfully. CAN bus errors are ignored.

pub fn error_count(&self) -> u64

Returns the number of transfers that could not be transmitted

A failure to allocate memory is considered an error. CAN bus errors are ignored.

Trait Implementations

impl<C, D> Transmitter<C> for CanTransmitter<C, D>where C: Clock, D: TransmitDriver<C>,

fn push<A>( &mut self, transfer: Transfer<A, C::Instant, CanTransport>, clock: &mut C, driver: &mut D ) -> Result<(), Self::Error>where A: AsRef<[u8]>,

Breaks a transfer into frames

The frames can be retrieved and sent using the peek() and pop() functions.

This function returns an error if the queue does not have enough space to hold all the required frames.

type Transport = CanTransport

The transport that this transmitter works with

type Driver = D

The driver type that this transmitter uses to send frames

type Error = Error<<D as TransmitDriver<C>>::Error>

An error type

fn flush(&mut self, clock: &mut C, driver: &mut D) -> Result<(), Self::Error>

Attempts to send all queued outgoing frames

fn mtu(&self) -> usize

Returns the maximum transmission unit of this transport, in bytes