RSM_INTR_SIGNAL_WAIT_POLLFD(3RSM) Remote Shared Memory Library Functions


NAME


rsm_intr_signal_wait_pollfd - wait for events on a list of file
descriptors

SYNOPSIS


cc [ flag... ] file... -lrsm [ library ... ]
#include <rsmapi.h>

int rsm_intr_signal_wait_pollfd(struct pollfd fds[],
nfds_t nfds, int timeout, int *numfdsp);


DESCRIPTION


The rsm_intr_signal_wait_pollfd() function is similar to
rsm_intr_signal_wait(3RSM), except that it allows an application to
multiplex I/O over various types of file descriptors. Applications can
use this function to wait for interrupt signals on RSMAPI segments as
well as poll for I/O events on other non-RSMAPI file descriptors.


The fds argument is an array of pollfd structures that correspond to both
RSMAPI segments and other file descriptors. The
rsm_memseg_get_pollfd(3RSM) is used to obtain a pollfd structure
corresponding to an RSMAPI segment.


The number of file descriptors that have events is returned in numfdsp.
This parameter can be set to NULL if the application is not interested in
the number of file descriptors that have events. See poll(2) for
descriptions of the pollfd structure as well as the nfds and timeout
parameters.


It is the application's responsibility to establish the validity of a
pollfd structure corresponding to an RSMAPI segment by ensuring that
rsm_memseg_release_pollfd(3RSM) has not been called on the segment or
that the segment has not been destroyed.


For file descriptors other than RSMAPI segments, the behavior of
rsm_intr_signal_wait_pollfd() is similar to poll().

RETURN VALUES


Upon successful completion, rsm_intr_signal_wait_pollfd() returns 0 and
the revents member of the pollfd struct corresponding to an RSMAPI
segment is set to POLLRDNORM, indicating that an interrupt signal for
that segment was received. Otherwise, an error value is returned.


For file descriptors other than RSMAPI segments, the revents member of
the pollfd struct is identical to that returned by poll(2).

ERRORS


The rsm_intr_signal_wait_pollfd() function can return the following
errors:

RSMERR_TIMEOUT

Timeout has occurred.


RSMERR_BAD_ARGS_ERRORS

Invalid arguments passed.


RSMERR_BAD_ADDR

An argument points to an illegal address.


RSMERR_INTERRUPTED

The call was interrupted.


RSMERR_INSUFFICIENT_MEM

Insufficient memory.


RSMERR_INSUFFICIENT_RESOURCES

Insufficient resources.


ATTRIBUTES


See attributes(5) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO


poll(2), rsm_intr_signal_wait(3RSM), rsm_memseg_get_pollfd(3RSM),
rsm_memseg_release_pollfd(3RSM), attributes(5)


April 9, 2016
RSM_INTR_SIGNAL_WAIT_POLLFD(3RSM)