Struct xsk_rs::TxQueue

pub struct TxQueue { /* private fields */ }

The transmitting side of an AF_XDP Socket.

More details can be found in the docs.

Implementations

impl TxQueue

pub unsafe fn produce(&mut self, descs: &[FrameDesc]) -> usize

Let the kernel know that the frames described by descs are ready to be transmitted. Returns the number of frames submitted to the kernel.

Note that if the length of descs is greater than the number of available spaces on the underlying ring buffer then no frames at all will be submitted for transmission.

Once the frames have been submitted to this queue they should not be used again until consumed via the CompQueue.

Safety

This function is unsafe as it is possible to cause a data race if used improperly. For example, by simultaneously submitting the same frame to this TxQueue and the FillQueue.

Furthermore, the frames passed to this queue must belong to the same Umem that this TxQueue instance is tied to.

pub unsafe fn produce_one(&mut self, desc: &FrameDesc) -> usize

Same as produce but for a single frame descriptor.

Safety

See produce.

pub unsafe fn produce_and_wakeup(
    &mut self,
    descs: &[FrameDesc]
) -> Result<usize>

Same as produce but wake up the kernel to continue processing produced frames (if required).

For more details see the docs.

Safety

See produce.

pub unsafe fn produce_one_and_wakeup(
    &mut self,
    desc: &FrameDesc
) -> Result<usize>

Same as produce_and_wakeup but for a single frame descriptor.

Safety

See produce.

pub fn wakeup(&self) -> Result<()>

Wake up the kernel to continue processing produced frames.

See produce_and_wakeup for a link to docs with further explanation.

pub fn needs_wakeup(&self) -> bool

Check if the XDP_USE_NEED_WAKEUP flag is set on the tx ring. If so then this means a call to wakeup will be required to continue processing produced frames.

See produce_and_wakeup for link to docs with further explanation.

pub fn poll(&mut self, poll_timeout: i32) -> Result<bool>

Polls the socket, returning true if it is ready to write.

pub fn fd(&self) -> &Fd

A reference to the underlying Socket’s file descriptor.

pub fn fd_mut(&mut self) -> &mut Fd

A mutable reference to the underlying Socket’s file descriptor.

Trait Implementations

impl Debug for TxQueue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.