Struct XskSocket 

pub struct XskSocket { /* private fields */ }

AF_XDP socket with three-tier opportunistic fallback engine.

Implementations

impl XskSocket

pub fn bind_opportunistic( ifname: &str, queue_id: u32, umem: &UmemPool, ) -> Result<Self>

Attempts opportunistic binding of an AF_XDP socket.

Fallback order:

1. Zero-Copy mode (XskBindMode::ZeroCopy)
2. Copy mode (XskBindMode::Copy)
3. Portable recvmmsg fallback (XskBindMode::FallbackRecvmmsg)

If running unprivileged or kernel lacks AF_XDP, cleanly returns FallbackRecvmmsg.

pub fn fallback() -> Self

Creates a fallback socket instance in FallbackRecvmmsg mode without an active AF_XDP socket.

pub fn mode(&self) -> XskBindMode

The active bind mode of this socket (ZeroCopy, Copy, or FallbackRecvmmsg).

pub fn fd(&self) -> RawFd

The raw file descriptor of the underlying AF_XDP socket, or -1 in fallback mode.

pub fn rx_ring_mut(&mut self) -> &mut RxRing

Mutable reference to the socket’s RX ring buffer.

pub fn tx_ring_mut(&mut self) -> &mut TxRing

Mutable reference to the socket’s TX ring buffer.

pub fn rx_ring(&self) -> &RxRing

Immutable reference to the socket’s RX ring buffer.

pub fn tx_ring(&self) -> &TxRing

Immutable reference to the socket’s TX ring buffer.

pub fn filter(&self) -> Option<&XdpRedirectFilter>

Reference to the attached eBPF redirect filter, if active.

pub fn filter_mut(&mut self) -> Option<&mut XdpRedirectFilter>

Mutable reference to the attached eBPF redirect filter, if active.

pub fn attach_bpf_filter( &mut self, ifname: &str, listen_port: u16, queue_id: u32, ) -> BpfFilterStatus

Opportunistically attaches an eBPF XDP redirect filter steering incoming UDP traffic for listen_port on ifname into this socket’s RX ring.

pub fn attach_bpf_filter_multi_queue( &mut self, ifname: &str, listen_port: u16, queue_fds: &[(u32, RawFd)], ) -> BpfFilterStatus

Opportunistically attaches a multi-queue eBPF XDP redirect filter steering incoming UDP traffic for listen_port on ifname across multiple RX queues into core-pinned AF_XDP rings.

pub fn set_bpf_filter_queue_socket( &mut self, queue_id: u32, xsk_fd: RawFd, ) -> Result<()>

Sets or updates the socket file descriptor for a specific queue ID in the attached BPF filter.

pub fn bind_multi_queue( ifname: &str, queue_ids: &[u32], umem: &UmemPool, ) -> Result<Vec<(u32, Self)>>

Binds multiple AF_XDP sockets across queue_ids for the given interface and UMEM pool.

Returns a list of (queue_id, XskSocket) pairs. If binding fails for a queue, a socket in fallback mode is returned for that queue.

Trait Implementations

impl Drop for XskSocket

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.