Condy v1.9
C++ Asynchronous System Call Layer for Linux
Loading...
Searching...
No Matches
condy::RingSettings Class Reference

Settings manager for io_uring. More...

#include <ring_settings.hpp>

Public Member Functions

int apply_iowq_aff (size_t cpusz, const cpu_set_t *mask) noexcept
 Apply I/O worker queue affinity settings.
int remove_iowq_aff () noexcept
 Remove I/O worker queue affinity settings.
int set_iowq_max_workers (unsigned int *values) noexcept
 Set the maximum number of I/O workers.
io_uring_probe * get_probe () noexcept
 Get the io_uring probe for the ring.
uint32_t get_features () const noexcept
 Get the supported features of the ring.

Detailed Description

Settings manager for io_uring.

This class provides an interface to manage various runtime settings for an io_uring instance, including NAPI, clock, and other features.

Definition at line 162 of file ring_settings.hpp.

Member Function Documentation

◆ apply_iowq_aff()

int condy::RingSettings::apply_iowq_aff ( size_t cpusz,
const cpu_set_t * mask )
inlinenoexcept

Apply I/O worker queue affinity settings.

See io_uring_register_iowq_aff for more details.

Parameters
cpuszNumber of CPUs in the affinity mask.
maskPointer to the CPU affinity mask.

Definition at line 182 of file ring_settings.hpp.

◆ get_features()

uint32_t condy::RingSettings::get_features ( ) const
inlinenoexcept

Get the supported features of the ring.

Returns
uint32_t Supported features bitmask.

Definition at line 220 of file ring_settings.hpp.

◆ get_probe()

io_uring_probe * condy::RingSettings::get_probe ( )
inlinenoexcept

Get the io_uring probe for the ring.

Returns
io_uring_probe* Pointer to the io_uring probe structure. User shall not free the returned pointer.

Definition at line 208 of file ring_settings.hpp.

◆ remove_iowq_aff()

int condy::RingSettings::remove_iowq_aff ( )
inlinenoexcept

Remove I/O worker queue affinity settings.

Returns
int Returns 0 on success or a negative error code on failure

Definition at line 189 of file ring_settings.hpp.

◆ set_iowq_max_workers()

int condy::RingSettings::set_iowq_max_workers ( unsigned int * values)
inlinenoexcept

Set the maximum number of I/O workers.

See io_uring_register_iowq_max_workers for more details.

Parameters
valuesPointer to an array with 2 elements representing the max_workers

Definition at line 199 of file ring_settings.hpp.


The documentation for this class was generated from the following file: