diff --git a/functions/pcntl.xml b/functions/pcntl.xml index 8982a53e7a..ec44fd070f 100644 --- a/functions/pcntl.xml +++ b/functions/pcntl.xml @@ -1,5 +1,5 @@ - + Process Control Functions PCNTL @@ -182,128 +182,6 @@ function sig_handler($signo) { - - - - - pcntl_waitpid - Waits on or returns the status of a forked child - - - Description - - - int pcntl_waitpid - int pid - int status - int options - - - - The pcntl_waitpid function suspends execution - of the current process until a child as specified by the - pid argument has exited, or until a signal - is delivered whose action is to terminate the current process or - to call a signal handling function. If a child as requested by - pid has already exited by the time of the - call (a so-called "zombie" process), the function returns - immediately. Any system resources used by the child are - freed. Please see your system's waitpid(2) man page for specific - details as to how waitpid works on your system. - - - pcntl_waitpid returns the process ID of the - child which exited, -1 on error or zero if WNOHANG was used and no - child was available - - - The value of pid can be one of the following: - - - < -1 - - - wait for any child process whose process group ID is equal to - the absolute value of pid. - - - - - -1 - - - wait for any child process; this is the same behaviour that - the wait function exhibits. - - - - - 0 - - - wait for any child process whose process group ID is equal to - that of the calling process. - - - - - > 0 - - - wait for the child whose process ID is equal to the value of - pid. - - - - - - - pcntl_waitpid will store status information - in the status parameter which can be - evaluated using the following functions: - pcntl_wifexited, - pcntl_wifstopped, - pcntl_wifsignaled, - pcntl_wexitstatus, - pcntl_wtermsig and - pcntl_wstopsig. - - - The value of options is the value of zero - or more of the following two global constants - ORed together: - - - WNOHANG - - - return immediately if no child has exited. - - - - - WUNTRACED - - - return for children which are stopped, and whose status has - not been reported. - - - - - - - See also pcntl_fork, - pcntl_signal, - pcntl_wifexited, - pcntl_wifstopped, - pcntl_wifsignaled, - pcntl_wexitstatus, - pcntl_wtermsig and - pcntl_wstopsig. - - - @@ -340,6 +218,324 @@ function sig_handler($signo) { + + + pcntl_waitpid + Waits on or returns the status of a forked child + + + Description + + + int pcntl_waitpid + int pid + int status + int options + + + + The pcntl_waitpid function suspends execution + of the current process until a child as specified by the + pid argument has exited, or until a signal + is delivered whose action is to terminate the current process or + to call a signal handling function. If a child as requested by + pid has already exited by the time of the + call (a so-called "zombie" process), the function returns + immediately. Any system resources used by the child are + freed. Please see your system's waitpid(2) man page for specific + details as to how waitpid works on your system. + + + pcntl_waitpid returns the process ID of the + child which exited, -1 on error or zero if WNOHANG was used and no + child was available + + + The value of pid can be one of the following: + + possible values for <parameter>pid</parameter> + + + + < -1 + + wait for any child process whose process group ID is equal to + the absolute value of pid. + + + + -1 + + wait for any child process; this is the same behaviour that + the wait function exhibits. + + + + 0 + + wait for any child process whose process group ID is equal to + that of the calling process. + + + + > 0 + + wait for the child whose process ID is equal to the value of + pid. + + + + +
+ + + pcntl_waitpid will store status information + in the status parameter which can be + evaluated using the following functions: + pcntl_wifexited, + pcntl_wifstopped, + pcntl_wifsignaled, + pcntl_wexitstatus, + pcntl_wtermsig and + pcntl_wstopsig. + + + The value of options is the value of zero + or more of the following two global constants + OR'ed together: + + possible values for <parameter>options</parameter> + + + + WNOHANG + + return immediately if no child has exited. + + + + WUNTRACED + + return for children which are stopped, and whose status has + not been reported. + + + + +
+ + + See also pcntl_fork, + pcntl_signal, + pcntl_wifexited, + pcntl_wifstopped, + pcntl_wifsignaled, + pcntl_wexitstatus, + pcntl_wtermsig and + pcntl_wstopsig. + + + + + + + + pcntl_wexitstatus + + Returns the return code of a terminated child + + + + Description + + + int pcntl_wexitstatus + int status + + + + Returns the return code of a terminated child. This function is + only useful if pcntl_wifexited returned + &true;. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid and + pcntl_wifexited. + + + + + + + + pcntl_wifexited + + Returns &true; if status code represents a successful exit + + + + Description + + + int pcntl_wifexited + int status + + + + Returns &true; if the child status code represents a successful + exit. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid and + pcntl_wexitstatus. + + + + + + + + pcntl_wifsignaled + + Returns &true; if status code represents a termination due to a + signal + + + + Description + + + int pcntl_wifsignaled + int status + + + + Returns &true; if the child process exited because of a signal + which was not caught. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid and + pcntl_signal. + + + + + + + + pcntl_wifstopped + + Returns &true; if child process is currently stopped + + + + Description + + + int pcntl_wifstopped + int status + + + + Returns &true; if the child process which caused the return is + currently stopped; this is only possible if the call to + pcntl_waitpid was done using the option + WUNTRACED. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid. + + + + + + + + pcntl_wstopsig + + Returns the signal which caused the child to stop + + + + Description + + + int pcntl_wstopsig + int status + + + + Returns the number of the signal which caused the child to stop. + This function is only useful if + pcntl_wifstopped returned &true;. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid and + pcntl_wifstopped. + + + + + + + + pcntl_wtermsig + + Returns the signal which caused the child to terminate + + + + Description + + + int pcntl_wtermsig + int status + + + + Returns the number of the signal that caused the child process to + terminate. This function is only useful if + pcntl_wifsignaled returned &true;. + + + The parameter status is the status + parameter supplied to a successfull call to + pcntl_waitpid. + + + See also pcntl_waitpid, + pcntl_signal and + pcntl_wifsignaled. + + + + +