Struct TxRing

pub struct TxRing<'a> { /* private fields */ }

Tx DMA state

Implementations

impl<'ring> TxRing<'ring>

pub fn next_entry_available(&self) -> bool

If this returns true, the next send will succeed.

pub fn send_next<'borrow>( &'borrow mut self, length: usize, packet_id: Option<PacketId>, ) -> Result<TxPacket<'borrow, 'ring>, TxError>

Prepare a packet for sending.

Write the data that you wish to send to the buffer represented by the returned TxPacket by using it as a slice.

When all data is copied into the TX buffer, use TxPacket::send() to transmit it.

pub async fn prepare_packet<'borrow>( &'borrow mut self, length: usize, packet_id: Option<PacketId>, ) -> TxPacket<'borrow, 'ring>

Prepare a packet for sending.

Write the data that you wish to send to the buffer represented by the returned TxPacket by using it as a slice.

When all data is copied into the TX buffer, use TxPacket::send() to transmit it.

pub fn is_running(&self) -> bool

Is the Tx DMA engine running?

impl TxRing<'_>

pub fn wait_for_timestamp( &self, packet_id: &PacketId, ) -> Result<Option<Timestamp>, PacketIdNotFound>

Blockingly wait untill the timestamp for the given ID is available.

pub fn poll_timestamp( &self, packet_id: &PacketId, ) -> Poll<Result<Option<Timestamp>, PacketIdNotFound>>

Poll to check if the timestamp for the given ID is already available.

pub async fn timestamp( &mut self, packet_id: &PacketId, ) -> Result<Option<Timestamp>, PacketIdNotFound>

Wait until the timestamp for the given ID is available.