NAME
waitid — wait for
a child process to change state
SYNOPSIS
#include
<sys/wait.h>
int waitid(idtype_t idtype, id_t id, siginfo_t *infop, int options);
DESCRIPTION
The waitid () function shall suspend the
calling thread until one child of the process containing the calling thread
changes state. It records the current state of a child in the structure
pointed to by infop. The fields of the structure pointed
to by infop are filled in as described for the SIGCHLD
signal in <signal.h>. If a child process
changed state prior to the call to waitid (),
waitid () shall return immediately. If more than one
thread is suspended in wait(3),
waitid (), or waitpid(3) waiting
for termination of the same process, exactly one thread shall return the
process status at the time of the target process termination.
The idtype and id arguments
are used to specify which children waitid () waits
for.
If idtype is P_PID,
waitid () shall wait for the child with a process ID
equal to ( pid_t) id.
If idtype is P_PGID,
waitid () shall wait for any child with a process
group ID equal to ( pid_t) id.
If idtype is P_ALL,
waitid () shall wait for any children and
id is ignored.
The options argument is used to specify which
state changes waitid () shall wait for. It is formed
by OR'ing together the following flags:
- WCONTINUED
- Status shall be returned for any child that was stopped and has been continued.
- WEXITED
- Wait for processes that have exited.
- WNOHANG
- Do not hang if no status is available; return immediately.
- WNOWAIT
- Keep the process whose status is returned in infop in a waitable state. This shall not affect the state of the process; the process may be waited for again after this call completes.
- WSTOPPED
- Status shall be returned for any child that has stopped upon receipt of a signal.
Applications shall specify at least one of the flags WEXITED, WSTOPPED, or WCONTINUED to be OR'ed in with the options argument.
The application shall ensure that the
infop argument points to a
siginfo_t
structure. If waitid () returns because a child
process was found that satisfied the conditions indicated by the arguments
idtype and options, then the structure
pointed to by infop shall be filled in by the system with
the status of the process. The
si_signo
member shall always be equal to SIGCHLD.
RETURN VALUE
If WNOHANG was specified and status is not available for any
process specified by idtype and id, 0
shall be returned. If waitid () returns due to the
change of state of one of its children, 0 shall be returned. Otherwise, -1
shall be returned and
errno
set to indicate the error.
ERRORS
The waitid () function shall fail if:
EXAMPLES
None.
APPLICATION USAGE
Calls to waitid () with
idtype equal to P_ALL will collect information about any
child process. This may result in interactions with other interfaces that
may be waiting for their own children (such as by use of
system(3)). For this reason it is recommended that
portable applications not use waitid () with idtype
of P_ALL. See also APPLICATION USAGE for wait(3).
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
XBD <signal.h> , <sys/wait.h>
CHANGE HISTORY
First released in Issue 4, Version 2.
Issue 5
Moved from X/OPEN UNIX extension to BASE.
The DESCRIPTION is updated for alignment with the POSIX Threads Extension.
Issue 6
The normative text is updated to avoid use of the term "must" for application requirements.
Issue 7
Austin Group Interpretation 1003.1-2001 #060 is applied, updating the DESCRIPTION.
The waitid () function is moved from the
XSI option to the Base.
APPLICATION USAGE is added, recommending that the
waitid () function not be used with
idtype equal to P_ALL.
The description of the WNOHANG flag is updated.