Struct xsk_rs::socket::RxQueue

pub struct RxQueue { /* private fields */ }

The receiving side of an AF_XDP Socket.

More details can be found in the docs.

Implementations

impl RxQueue

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

Update descs with information on which Umem frames have received packets. Returns the number of elements of descs which have been updated.

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.

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.

Safety

The frames passed to this queue must belong to the same Umem that this RxQueue instance is tied to.

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

Same as consume but for a single frame descriptor.

Safety

See consume.

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

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

Safety

See consume.

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

Same as poll_and_consume but for a single frame descriptor.

Safety

See consume.

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

Polls the socket, returning true if there is data to read.

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 RxQueue

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

Formats the value using the given formatter.