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

File descriptor table for io_uring. More...

#include <ring.hpp>

Public Member Functions

int init (size_t capacity) noexcept
 Initialize the file descriptor table with the given capacity.
int init (const int *fds, unsigned nr_fds)
 Initialize the file descriptor table with the given array of file descriptors.
int destroy () noexcept
 Destroy the file descriptor table.
int update (unsigned index_base, const int *fds, unsigned nr_fds) noexcept
 Update the file descriptor table starting from the given index.
int set_file_alloc_range (unsigned offset, unsigned size) noexcept
 Set the file allocation range for the fd table.

Detailed Description

File descriptor table for io_uring.

This class makes an abstraction over the io_uring file registration interface.

Definition at line 23 of file ring.hpp.

Member Function Documentation

◆ destroy()

int condy::FdTable::destroy ( )
inlinenoexcept

Destroy the file descriptor table.

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

Definition at line 57 of file ring.hpp.

◆ init() [1/2]

int condy::FdTable::init ( const int * fds,
unsigned nr_fds )
inline

Initialize the file descriptor table with the given array of file descriptors.

Parameters
fdsPointer to the array of file descriptors to register
nr_fdsNumber of file descriptors in the array
Returns
int Returns 0 on success or a negative error code on failure

Definition at line 49 of file ring.hpp.

◆ init() [2/2]

int condy::FdTable::init ( size_t capacity)
inlinenoexcept

Initialize the file descriptor table with the given capacity.

Parameters
capacityThe number of file descriptors to allocate in the table
Returns
int Returns 0 on success or a negative error code on failure

Definition at line 38 of file ring.hpp.

◆ set_file_alloc_range()

int condy::FdTable::set_file_alloc_range ( unsigned offset,
unsigned size )
inlinenoexcept

Set the file allocation range for the fd table.

Parameters
offsetThe starting offset of the file allocation range
sizeThe size of the file allocation range
Returns
int Returns 0 on success or a negative error code on failure

Definition at line 77 of file ring.hpp.

◆ update()

int condy::FdTable::update ( unsigned index_base,
const int * fds,
unsigned nr_fds )
inlinenoexcept

Update the file descriptor table starting from the given index.

Parameters
index_baseThe starting index to update
fdsPointer to the array of file descriptors
nr_fdsNumber of file descriptors to update
Returns
int Return number of file descriptors updated on success or a negative error code on failure

Definition at line 67 of file ring.hpp.


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