Skip to content

[Sync EN] Add documentation for 6 new pcntl functions (PHP 8.4) #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Sync EN] Add documentation for 6 new pcntl functions (PHP 8.4) #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions reference/pcntl/functions/pcntl-forkx.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-forkx" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_forkx</refname>
<refpurpose>Erzeugt einen Kindprozess mittels forkx(2)</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pcntl_forkx</methodname>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<simpara>
Die Funktion <function>pcntl_forkx</function> erzeugt einen Kindprozess
mittels des Systemaufrufs <literal>forkx(2)</literal>, der auf illumos-
und Solaris-Systemen verfügbar ist.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<simpara>
Der Parameter <parameter>flags</parameter> steuert das Verhalten des
Forks. <literal>0</literal> für das Standardverhalten übergeben oder
<constant>FORK_NOSIGCHLD</constant>, um zu verhindern, dass das Signal
<constant>SIGCHLD</constant> an den Elternprozess gesendet wird, wenn
der Kindprozess endet.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Bei Erfolg wird die PID des Kindprozesses an den Ausführungsstrang des
Elternprozess und eine <literal>0</literal> an den Ausführungsstrang des
Kindes zurückgegeben. Bei einem Fehlschlag wird <literal>-1</literal> im
Kontext des Elternprozess zurückgegeben, kein Kindprozess erzeugt und ein
PHP-Fehler ausgelöst.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_fork</function></member>
<member><function>pcntl_rfork</function></member>
<member><function>pcntl_waitpid</function></member>
</simplelist>
</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
-->
62 changes: 62 additions & 0 deletions reference/pcntl/functions/pcntl-getcpu.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-getcpu" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_getcpu</refname>
<refpurpose>Ermittelt die Nummer der CPU, auf der der aufrufende Prozess zuletzt ausgeführt wurde</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pcntl_getcpu</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>pcntl_getcpu</function> gibt die Nummer der CPU zurück, auf der
der aufrufende Prozess zuletzt ausgeführt wurde. Diese Funktion verwendet
den unter Linux verfügbaren Systemaufruf <literal>sched_getcpu(3)</literal>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt die CPU-Nummer als &integer; zurück.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_getcpuaffinity</function></member>
<member><function>pcntl_setcpuaffinity</function></member>
</simplelist>
</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
-->
25 changes: 8 additions & 17 deletions ...ce/pcntl/functions/pcntl_getqos_class.xml → ...ce/pcntl/functions/pcntl-getqos-class.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 30b0c51175bb9bc5a329d7924b0ca5eff1f1f9ad Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-getqos-class" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_getqos_class</refname>
<refpurpose>Gibt die QoS-Klasse des aktuellen Threads zurück</refpurpose>
<refpurpose>Ermittelt die aktuelle Quality-of-Service-Klasse des Prozesses</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -14,11 +13,11 @@
<void/>
</methodsynopsis>
<simpara>
Ermittelt die QoS-Klasse.
Gibt die aktuelle Quality-of-Service-Klasse (<acronym>QoS</acronym>) des
aufrufenden Prozesses zurück. Diese Funktion ist nur unter macOS
verfügbar, das <acronym>QoS</acronym>-Klassen zur Steuerung von
Energieeffizienz und Leistung verwendet.
</simpara>
<note>
<simpara>Diese Funktion ist nur auf Apple-Plattformen verfügbar.</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -29,23 +28,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt die <enumname>Pcntl\QosClass</enumname> zurück.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Wirft einen <classname>Error</classname>, wenn der zugrunde liegende Aufruf von
<literal>pthread_get_qos_class_np()</literal> fehlschlägt.
Gibt einen Enum-Wert <classname>Pcntl\QosClass</classname> zurück, der die
aktuelle <acronym>QoS</acronym>-Klasse repräsentiert.
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_setqos_class</function></member>
<member><enumname>Pcntl\QosClass</enumname></member>
</simplelist>
</refsect1>

Expand Down
86 changes: 86 additions & 0 deletions reference/pcntl/functions/pcntl-setns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-setns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_setns</refname>
<refpurpose>Verknüpft den aufrufenden Prozess mit einem Namespace eines anderen Prozesses neu</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pcntl_setns</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>process_id</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>nstype</parameter><initializer><constant>CLONE_NEWNET</constant></initializer></methodparam>
</methodsynopsis>
<simpara>
Verknüpft den aufrufenden Prozess mit einem Linux-Namespace des durch
<parameter>process_id</parameter> angegebenen Prozesses neu; dabei werden
ein per <literal>pidfd_open(2)</literal> ermittelter pidfd und
<literal>setns(2)</literal> verwendet.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>process_id</parameter></term>
<listitem>
<simpara>
Die Prozess-ID des Zielprozesses, dessen Namespace beigetreten werden
soll. Bei &null; wird die eigene PID des aufrufenden Prozesses
verwendet.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nstype</parameter></term>
<listitem>
<simpara>
Der Namespace-Typ, mit dem neu verknüpft werden soll. Standard ist
<constant>CLONE_NEWNET</constant> (Netzwerk-Namespace). Mögliche Werte
sind unter anderem <constant>CLONE_NEWNET</constant>,
<constant>CLONE_NEWIPC</constant>,
<constant>CLONE_NEWUTS</constant> und weitere.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_unshare</function></member>
</simplelist>
</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
-->
79 changes: 79 additions & 0 deletions reference/pcntl/functions/pcntl-setqos-class.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-setqos-class" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_setqos_class</refname>
<refpurpose>Setzt die Quality-of-Service-Klasse des Prozesses</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>pcntl_setqos_class</methodname>
<methodparam choice="opt"><type>Pcntl\QosClass</type><parameter>qos_class</parameter><initializer>Pcntl\QosClass::Default</initializer></methodparam>
</methodsynopsis>
<simpara>
Setzt die Quality-of-Service-Klasse (<acronym>QoS</acronym>) des
aufrufenden Prozesses. Diese Funktion ist nur unter macOS verfügbar, das
<acronym>QoS</acronym>-Klassen zur Steuerung von Energieeffizienz und
Leistung verwendet.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>qos_class</parameter></term>
<listitem>
<simpara>
Die zu setzende <acronym>QoS</acronym>-Klasse. Muss einer der
Enum-Werte von <classname>Pcntl\QosClass</classname> sein:
</simpara>
<simplelist>
<member><literal>Pcntl\QosClass::UserInteractive</literal></member>
<member><literal>Pcntl\QosClass::UserInitiated</literal></member>
<member><literal>Pcntl\QosClass::Default</literal></member>
<member><literal>Pcntl\QosClass::Utility</literal></member>
<member><literal>Pcntl\QosClass::Background</literal></member>
</simplelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>pcntl_getqos_class</function></member>
</simplelist>
</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
-->
Loading
Loading