Struct xsk_rs::socket::Socket

pub struct Socket { /* private fields */ }

An AF_XDP socket.

More details can be found in the docs

Implementations

impl Socket

pub fn new(
    config: SocketConfig,
    umem: &Umem,
    if_name: &Interface,
    queue_id: u32
) -> Result<(TxQueue, RxQueue, Option<(FillQueue, CompQueue)>), SocketCreateError>

Create and bind a new AF_XDP socket to a given interface and queue id using the underlying UMEM.

May require root permissions to create successfully.

Whether you can expect the returned Option<(FillQueue, CompQueue)> to be Some or None depends on a couple of things:

1. If the Umem is currently shared (i.e. being used for >=1 AF_XDP sockets elsewhere):

• If the (if_name, queue_id) pair is not bound to, expect Some.

• If the (if_name, queue_id) pair is bound to, expect None and use the FillQueue and CompQueue originally returned for this pair.

2. If the Umem is not currently shared, expect Some.

For further details on using a shared Umem please see the docs.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Socket

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

Formats the value using the given formatter.