Skip to content

[Sync EN] pcntl: Fix duplicate documentation for pcntl_getqos_class and pcntl_setqos_class #789

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

Merged
julionc merged 1 commit into from
Jun 15, 2026
+95 −23
Merged

[Sync EN] pcntl: Fix duplicate documentation for pcntl_getqos_class and pcntl_setqos_class #789

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
26 changes: 18 additions & 8 deletions reference/pcntl/functions/pcntl-getqos-class.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<!-- EN-Revision: 28192e830f2c204570cc140c24341d07807df8bc Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-getqos-class" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_getqos_class</refname>
<refpurpose>Obtiene la clase de calidad de servicio actual del proceso</refpurpose>
<refpurpose>Obtiene la clase de calidad de servicio del hilo actual</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -13,11 +13,12 @@
<void/>
</methodsynopsis>
<simpara>
Devuelve la clase de calidad de servicio (<acronym>QoS</acronym>) actual
del proceso llamante. Esta función solo está disponible en macOS, que
utiliza las clases <acronym>QoS</acronym> para gestionar la eficiencia
energética y el rendimiento.
Recupera la clase de calidad de servicio (<acronym>QoS</acronym>) del
hilo actual.
</simpara>
<note>
<simpara>Esta función solo está disponible en plataformas Apple.</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -28,15 +29,24 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Devuelve un valor de la enumeración <classname>Pcntl\QosClass</classname>
que representa la clase <acronym>QoS</acronym> actual.
Devuelve la clase <acronym>QoS</acronym> actual como un
<enumname>Pcntl\QosClass</enumname>.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Lanza un <exceptionname>Error</exceptionname> si la llamada subyacente a
<literal>pthread_get_qos_class_np()</literal> falla.
</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
92 changes: 77 additions & 15 deletions reference/pcntl/functions/pcntl-setqos-class.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: acb474ea92ab6226eaf419a85de05f68c6715a9f Maintainer: lacatoire Status: ready -->
<!-- EN-Revision: 28192e830f2c204570cc140c24341d07807df8bc Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.pcntl-setqos-class" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_setqos_class</refname>
<refpurpose>Establece la clase de calidad de servicio del proceso</refpurpose>
<refpurpose>Establece la clase de calidad de servicio del hilo actual</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>
<methodparam choice="opt"><type>Pcntl\QosClass</type><parameter>qos_class</parameter><initializer><constant>Pcntl\QosClass::Default</constant></initializer></methodparam>
</methodsynopsis>
<simpara>
Establece la clase de calidad de servicio (<acronym>QoS</acronym>) del
proceso llamante. Esta función solo está disponible en macOS, que utiliza
las clases <acronym>QoS</acronym> para gestionar la eficiencia energética
y el rendimiento.
hilo actual.
</simpara>
</refsect1>

Expand All @@ -27,19 +25,74 @@
<term><parameter>qos_class</parameter></term>
<listitem>
<simpara>
La clase <acronym>QoS</acronym> a establecer. Debe ser uno de los
valores de la enumeración <classname>Pcntl\QosClass</classname>:
La clase de calidad de servicio a asignar al hilo actual. El sistema
operativo la utiliza como una indicación para planificar el tiempo de
CPU, la prioridad de E/S y el consumo de energía, donde las clases
superiores tienen prioridad sobre las inferiores. Véase
<enumname>Pcntl\QosClass</enumname> para los casos disponibles.
</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>
<variablelist>
<varlistentry>
<term><constant>Pcntl\QosClass::UserInteractive</constant></term>
<listitem>
<simpara>
Prioridad más alta. Destinada al trabajo que controla directamente
una interfaz de usuario y debe completarse prácticamente al instante
para evitar retrasos perceptibles, como la gestión de eventos o el
dibujado.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>Pcntl\QosClass::UserInitiated</constant></term>
<listitem>
<simpara>
Prioridad alta, justo por debajo de <constant>UserInteractive</constant>.
Destinada al trabajo que el usuario ha iniciado explícitamente y está
esperando activamente, que se espera que se complete en unos pocos
segundos.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>Pcntl\QosClass::Default</constant></term>
<listitem>
<simpara>
Prioridad estándar, utilizada cuando no se aplica ninguna clase más
específica. Se ejecuta después del trabajo de mayor prioridad pero
antes de <constant>Utility</constant> y <constant>Background</constant>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>Pcntl\QosClass::Utility</constant></term>
<listitem>
<simpara>
Prioridad inferior, destinada al trabajo de larga duración del que el
usuario es consciente pero que no está esperando activamente, como
descargas, importaciones o cálculos masivos. Se planifica de forma
eficiente energéticamente.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>Pcntl\QosClass::Background</constant></term>
<listitem>
<simpara>
Prioridad más baja, destinada al trabajo del que el usuario no es
consciente, como la precarga, la indexación o el mantenimiento. Muy
optimizada para la eficiencia energética y puede aplazarse cuando el
sistema está bajo carga.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<note>
<simpara>Esta función solo está disponible en plataformas Apple.</simpara>
</note>
</refsect1>

<refsect1 role="returnvalues">
Expand All @@ -49,10 +102,19 @@
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Lanza un <exceptionname>Error</exceptionname> si la llamada subyacente a
<literal>pthread_set_qos_class_self_np()</literal> falla.
</simpara>
</refsect1>

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

Expand Down