Struct libbpf_rs::RingBuffer

pub struct RingBuffer<'cb> { /* private fields */ }

The canonical interface for managing a collection of ringbuf maps.

ringbufs are a special kind of Map, used to transfer data between Programs and userspace. As of Linux 5.8, the ringbuf map is now preferred over the perf buffer.

Implementations

impl RingBuffer<'_>

pub fn poll_raw(&self, timeout: Duration) -> i32

Poll from all open ring buffers, calling the registered callback for each one. Polls continually until we either run out of events to consume or timeout is reached. If timeout is Duration::MAX, this will block indefinitely until an event occurs.

Return the amount of events consumed, or a negative value in case of error.

pub fn poll(&self, timeout: Duration) -> Result<()>

Poll from all open ring buffers, calling the registered callback for each one. Polls continually until we either run out of events to consume or timeout is reached. If timeout is Duration::MAX, this will block indefinitely until an event occurs.

pub fn consume_raw(&self) -> i32

Greedily consume from all open ring buffers, calling the registered callback for each one. Consumes continually until we run out of events to consume or one of the callbacks returns a non-zero integer.

Return the amount of events consumed, or a negative value in case of error.

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

Greedily consume from all open ring buffers, calling the registered callback for each one. Consumes continually until we run out of events to consume or one of the callbacks returns a non-zero integer.

pub fn epoll_fd(&self) -> i32

Get an fd that can be used to sleep until data is available

Trait Implementations

impl AsRawLibbpf for RingBuffer<'_>

fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType>

Retrieve the underlying libbpf_sys::ring_buffer.

type LibbpfType = ring_buffer

The underlying libbpf type.

impl<'cb> Debug for RingBuffer<'cb>

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

Formats the value using the given formatter.

impl Drop for RingBuffer<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for RingBuffer<'_>