Struct PduTx

pub struct PduTx<'sto> { /* private fields */ }

EtherCAT frame transmit adapter.

Implementations

impl<'sto> PduTx<'sto>

pub fn capacity(&self) -> usize

The number of frames that can be in flight at once.

pub fn next_sendable_frame(&mut self) -> Option<SendableFrame<'sto>>

Get the next sendable frame, if any are available.

pub fn replace_waker(&self, waker: &Waker)

Set or replace the PDU loop waker.

The waker must be set otherwise the future in charge of sending new packets will not be woken again, causing a timeout error.

Examples

use core::future::poll_fn;
use core::task::Poll;

let (pdu_tx, _pdu_rx, _pdu_loop) = PDU_STORAGE.try_split().expect("can only split once");

poll_fn(|ctx| {
    // Set the waker so this future is polled again when new EtherCAT frames are ready to
    // be sent.
    pdu_tx.replace_waker(ctx.waker());

    // Send and receive packets over the network interface here

    Poll::<()>::Pending
});

pub fn should_exit(&self) -> bool

Returns true if the PDU sender should exit.

This will be triggered by MainDevice::release_all. When giving back ownership of the PduTx, be sure to call release to ensure all internal state is correct before reuse.

pub fn release(self) -> Self

Reset this object ready for reuse.