Struct xdpsock::RxQueue

pub struct RxQueue<'umem> { /* fields omitted */ }

The receiving side of an AF_XDP socket.

More details can be found in the docs.

Implementations

impl RxQueue<'_>

pub fn consume(&mut self, descs: &mut [Frame<'_>]) -> usize

Populate descs with information on packets received on the rx ring.

The number of entries updated will be less than or equal to the length of descs. Entries will be updated sequentially from the start of descs until the end. Returns the number of elements of descs which have been updated with received packet information, namely their frame address and length.

Once the contents of the consumed frames have been dealt with and are no longer required, the frames should eventually be added back on to either the FillQueue or the TxQueue.

pub fn poll_and_consume(
    &mut self,
    descs: &mut [Frame<'_>],
    poll_timeout: i32
) -> Result<usize>

Same as consume but poll first to check if there is anything to read beforehand.

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

Return the AF_XDP socket’s file descriptor.

Required for poll_read or poll_write.

Trait Implementations

impl<'umem> Debug for RxQueue<'umem>

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

Formats the value using the given formatter.

impl Send for RxQueue<'_>