Ruby  3.4.0dev (2024-11-05 revision e440268d51fe02b303e3817a7a733a0dac1c5091)
Data Structures | Functions
win32.h File Reference

(e440268d51fe02b303e3817a7a733a0dac1c5091)

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

#include "ruby/internal/dosish.h"
#include "ruby/internal/attr/nonnull.h"
#include "ruby/internal/attr/pure.h"
#include "ruby/internal/attr/noalias.h"
#include "ruby/internal/dllexport.h"
#include "ruby/assert.h"
Include dependency graph for win32.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_set (int fd, rb_fdset_t *f)
 Sets an fd to a fdset. More...
 
void rb_w32_fd_copy (rb_fdset_t *dst, const fd_set *src, int max)
 Destructively overwrites an fdset with another. More...
 
void rb_w32_fd_dup (rb_fdset_t *dst, const rb_fdset_t *src)
 Identical to rb_w32_fd_copy(), except it copies unlimited number of file descriptors. More...
 
static void rb_fd_zero (rb_fdset_t *f)
 Wipes out the current set of FDs. More...
 
static void rb_fd_clr (int n, rb_fdset_t *f)
 Releases a specific FD from the given fdset. More...
 
static int rb_fd_isset (int n, rb_fdset_t *f)
 Queries if the given FD is in the given set. More...
 
static void rb_fd_copy (rb_fdset_t *dst, const fd_set *src, int n)
 Destructively overwrites an fdset with another. More...
 
static 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...
 
static int rb_fd_select (int n, 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.

Definition in file win32.h.

Function Documentation

◆ rb_fd_clr()

static void rb_fd_clr ( int  n,
rb_fdset_t f 
)
inlinestatic

Releases a specific FD from the given fdset.

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

Definition at line 136 of file win32.h.

◆ rb_fd_copy()

static void rb_fd_copy ( rb_fdset_t dst,
const fd_set *  src,
int  n 
)
inlinestatic

Destructively overwrites an fdset with another.

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

Definition at line 166 of file win32.h.

◆ rb_fd_dup()

static void rb_fd_dup ( rb_fdset_t dst,
const rb_fdset_t src 
)
inlinestatic

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.

Definition at line 181 of file win32.h.

◆ 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()

static int rb_fd_isset ( int  n,
rb_fdset_t f 
)
inlinestatic

Queries if the given FD is in the given set.

Parameters
[in]nTarget FD.
[in]fThe fdset to scan.
Return values
1Yes there is.
0No there isn't.

Definition at line 151 of file win32.h.

◆ 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 251 of file win32.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 237 of file win32.h.

◆ rb_fd_select()

static int rb_fd_select ( int  n,
rb_fdset_t rfds,
rb_fdset_t wfds,
rb_fdset_t efds,
struct timeval timeout 
)
inlinestatic

Waits for multiple file descriptors at once.

Parameters
[in]nMax 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.

Definition at line 212 of file win32.h.

◆ 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()

static void rb_fd_zero ( rb_fdset_t f)
inlinestatic

Wipes out the current set of FDs.

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

Definition at line 122 of file win32.h.

◆ rb_w32_fd_copy()

void rb_w32_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.

Definition at line 2985 of file win32.c.

Referenced by rb_fd_copy().

◆ rb_w32_fd_dup()

void rb_w32_fd_dup ( rb_fdset_t dst,
const rb_fdset_t src 
)

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

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

Definition at line 3000 of file win32.c.

Referenced by rb_fd_dup().