File: pcntl-rfork.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (154 lines) | stat: -rw-r--r-- 4,380 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.pcntl-rfork" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pcntl_rfork</refname>
  <refpurpose>Manipulates process resources</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pcntl_rfork</methodname>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>signal</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Manipulates process resources.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       The <parameter>flags</parameter> parameter determines which resources of the invoking process (parent)
       are shared by the new process (child) or initialized to their default values.
      </para>
      <para>
       <parameter>flags</parameter> is the logical OR of some subset of:
       <simplelist>
        <member>
         <constant>RFPROC</constant>: If set a new process is created;
         otherwise changes affect the current process.
        </member>
        <member>
         <constant>RFNOWAIT</constant>: If set, the child process will be dissociated from the parent.
         Upon exit the child will not leave a status for the parent to collect.
        </member>
        <member>
         <constant>RFFDG</constant>: If set, the invoker's file descriptor table is copied;
         otherwise the two processes share a single table.
        </member>
        <member>
         <constant>RFCFDG</constant>: If set, the new process starts with a clean file descriptor table.
         Is mutually exclusive with <constant>RFFDG</constant>.
        </member>
        <member>
         <constant>RFLINUXTHPN</constant>: If set, the kernel will return SIGUSR1 instead of SIGCHILD upon thread exit for the child.
         This is intended to do Linux clone exit parent notification.
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signal</parameter></term>
     <listitem>
      <para>
       The signal number.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success, the PID of the child process is returned in the
   parent's thread of execution, and a <literal>0</literal> is returned in the child's
   thread of execution. 
   On failure, a <literal>-1</literal> will be returned in the
   parent's context, no child process will be created, and a PHP error is raised.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pcntl_rfork</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$pid = pcntl_rfork(RFNOWAIT|RFTSIGZMB, SIGUSR1);
if ($pid > 0) {
  // This is the parent process.
  var_dump($pid);
} else {
  // This is the child process.
  var_dump($pid);
  sleep(2); // as the child does not wait, so we see its "pid"
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
int(77093)
int(0)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function is only available on BSD systems.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pcntl_fork</function></member>
    <member><function>pcntl_waitpid</function></member>
    <member><function>pcntl_signal</function></member>
    <member><function>cli_set_process_title</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->