Ruby  3.4.0dev (2024-11-05 revision 348a53415339076afc4a02fcd09f3ae36e9c4c61)
Data Structures | Functions
largesize.h File Reference

(348a53415339076afc4a02fcd09f3ae36e9c4c61)

Public APIs to provide rb_fd_select(). More...

#include "ruby/internal/attr/nonnull.h"
#include "ruby/internal/attr/pure.h"
#include "ruby/internal/dllexport.h"
Include dependency graph for largesize.h:

Go to the source code of this file.

Data Structures

struct  rb_fdset_t
 The data structure which wraps the fd_set bitmap used by select(2). More...
 

Functions

void rb_fd_init (rb_fdset_t *f)
 (Re-)initialises a fdset. More...
 
void rb_fd_term (rb_fdset_t *f)
 Destroys the rb_fdset_t, releasing any memory and resources it used. More...
 
void rb_fd_zero (rb_fdset_t *f)
 Wipes out the current set of FDs. More...
 
void rb_fd_set (int fd, rb_fdset_t *f)
 Sets an fd to a fdset. More...
 
void rb_fd_clr (int fd, rb_fdset_t *f)
 Releases a specific FD from the given fdset. More...
 
int rb_fd_isset (int fd, const rb_fdset_t *f)
 Queries if the given FD is in the given set. More...
 
void rb_fd_copy (rb_fdset_t *dst, const fd_set *src, int max)
 Destructively overwrites an fdset with another. More...
 
void rb_fd_dup (rb_fdset_t *dst, const rb_fdset_t *src)
 Identical to rb_fd_copy(), except it copies unlimited number of file descriptors. More...
 
int rb_fd_select (int nfds, rb_fdset_t *rfds, rb_fdset_t *wfds, rb_fdset_t *efds, struct timeval *timeout)
 Waits for multiple file descriptors at once. More...
 
static fd_set * rb_fd_ptr (const rb_fdset_t *f)
 Raw pointer to fd_set. More...
 
static int rb_fd_max (const rb_fdset_t *f)
 It seems this function has no use. More...
 

Detailed Description

Public APIs to provide rb_fd_select().

Author
Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org
Warning
Symbols prefixed with either RBIMPL or rbimpl are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.
Note
To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance __VA_ARGS__ is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Several Unix platforms support file descriptors bigger than FD_SETSIZE in select(2) system call.

When fd_set is not big enough to hold big file descriptors, it should be allocated dynamically. Note that this assumes fd_set is structured as bitmap.

rb_fd_init allocates the memory. rb_fd_term frees the memory. rb_fd_set may re-allocate bitmap.

So rb_fd_set doesn't reject file descriptors bigger than FD_SETSIZE.

Definition in file largesize.h.

Function Documentation

◆ rb_fd_clr()

void rb_fd_clr ( int  fd,
rb_fdset_t f 
)

Releases a specific FD from the given fdset.

Parameters
[in]fdTarget FD.
[out]fThe fdset that holds fd.
Postcondition
f doesn't hold n.

◆ rb_fd_copy()

void rb_fd_copy ( rb_fdset_t dst,
const fd_set *  src,
int  max 
)

Destructively overwrites an fdset with another.

Parameters
[out]dstTarget fdset.
[in]srcSource fdset.
[in]maxMaximum number of file descriptors to copy.
Postcondition
dst is a copy of src.

◆ rb_fd_dup()

void rb_fd_dup ( rb_fdset_t dst,
const rb_fdset_t src 
)

Identical to rb_fd_copy(), except it copies unlimited number of file descriptors.

Parameters
[out]dstTarget fdset.
[in]srcSource fdset.
Postcondition
dst is a copy of src.

◆ rb_fd_init()

void rb_fd_init ( rb_fdset_t f)

(Re-)initialises a fdset.

One must be initialised before other rb_fd_* operations. Analogous to calling malloc(3) to allocate an fd_set.

Parameters
[out]fAn fdset to squash.
Postcondition
f holds no file descriptors.

◆ rb_fd_isset()

int rb_fd_isset ( int  fd,
const rb_fdset_t f 
)

Queries if the given FD is in the given set.

Parameters
[in]fdTarget FD.
[in]fThe fdset to scan.
Return values
1Yes there is.
0No there isn't.
See also
http://www.freebsd.org/cgi/query-pr.cgi?pr=91421

◆ rb_fd_max()

static int rb_fd_max ( const rb_fdset_t f)
inlinestatic

It seems this function has no use.

Maybe just remove?

Parameters
[in]fA set.
Returns
Number of file descriptors stored.

Definition at line 209 of file largesize.h.

◆ rb_fd_ptr()

static fd_set* rb_fd_ptr ( const rb_fdset_t f)
inlinestatic

Raw pointer to fd_set.

Parameters
[in]fTarget fdset.
Return values
NULLf is already terminated by rb_fd_term().
otherwiseUnderlying fd_set.

Definition at line 195 of file largesize.h.

◆ rb_fd_select()

int rb_fd_select ( int  nfds,
rb_fdset_t rfds,
rb_fdset_t wfds,
rb_fdset_t efds,
struct timeval timeout 
)

Waits for multiple file descriptors at once.

Parameters
[in]nfdsMax FD in everything passed, plus one.
[in,out]rfdsSet of FDs to wait for reads.
[in,out]wfdsSet of FDs to wait for writes.
[in,out]efdsSet of FDs to wait for OOBs.
[in,out]timeoutMax blocking duration.
Return values
-1Failed, errno set.
0Timeout exceeded.
otherwiseTotal number of file descriptors returned.
Postcondition
rfds contains readable FDs.
wfds contains writable FDs.
efds contains exceptional FDs.
timeout is the time left.
Note
All pointers are allowed to be null pointers.

◆ rb_fd_set()

void rb_fd_set ( int  fd,
rb_fdset_t f 
)

Sets an fd to a fdset.

Parameters
[in]fdA file descriptor.
[out]fTarget fdset.
Postcondition
f holds fd.

◆ rb_fd_term()

void rb_fd_term ( rb_fdset_t f)

Destroys the rb_fdset_t, releasing any memory and resources it used.

It must be reinitialised using rb_fd_init() before future use. Analogous to calling free(3) to release memory for an fd_set.

Parameters
[out]fAn fdset to squash.
Postcondition
f holds no file descriptors.

◆ rb_fd_zero()

void rb_fd_zero ( rb_fdset_t f)

Wipes out the current set of FDs.

Parameters
[out]fThe fdset to clear.
Postcondition
f has no FDs.