svn: /phpdoc/ru/trunk/reference/pthreads/worker/ collect.xml getstacked.xml isshutdown.xml isworking.xml shutdown.xml stack.xml unstack.xml

Added: phpdoc/ru/trunk/reference/pthreads/worker/collect.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/collect.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/collect.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 342988 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.collect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::collect</refname>
+  <refpurpose>Собрать ссылки на завершённые задачи</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>Worker::collect</methodname>
+   <methodparam choice="opt"><type>Callable</type><parameter>collector</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Позволяет Worker'у собрать "мусорные" ссылки на задачи.
+   Опционально можно задать пользовательский сборщик.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>collector</parameter></term>
+    <listitem>
+     <para>
+      Сборщик типа Callable, который должен возвращать &true; или
+      &false; в зависимости от того, можно ли собрать задачу.
+      Случаи, когда вам может понадобиться собственный
+      сборщик, крайне редки.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Количество оставшихся задач в стеке Worker'а, которые будут
+   собраны.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Пример использования <methodname>Worker::collect</methodname></title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$worker = new Worker();
+
+echo "Сейчас на стеке {$worker->collect()} задач, которые нужно собрать\n";
+
+for ($i = 0; $i < 15; ++$i) {
+    $worker->stack(new class extends Threaded {});
+}
+
+echo "На стеке {$worker->collect()} задач, которые нужно собрать\n";
+
+$worker->start();
+
+while ($worker->collect()); // ждём, пока все задачи не завершат исполнение
+
+echo "Теперь на стеке {$worker->collect()} задач, ждущих, когда их соберут\n";
+
+$worker->shutdown();
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Сейчас на стеке 0 задач, которые нужно собрать
+На стеке 15 задач, которые нужно собрать
+Теперь на стеке 0 задач, ждущих, когда их соберут
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/collect.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/getstacked.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/getstacked.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/getstacked.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 341654 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.getstacked" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::getStacked</refname>
+  <refpurpose>Возвращает текущий размер стека</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>Worker::getStacked</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Возвращает количество задач, оставшихся в стеке.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Возвращает количество задач, оставшихся в стеке и ожидающих
+   запуска.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Пример использования <classname>Worker::getStacked</classname></title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$worker = new Worker();
+
+for ($i = 0; $i < 5; ++$i) {
+    $worker->stack(new class extends Threaded {});
+}
+
+echo "There are {$worker->getStacked()} stacked tasks\n";
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+There are 5 stacked tasks
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/getstacked.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/isshutdown.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/isshutdown.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/isshutdown.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 341654 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.isshutdown" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::isShutdown</refname>
+  <refpurpose>Определение состояния</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>Worker::isShutdown</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Определяет, остановлен Worker или нет.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &true; если остановлен и &false;, если нет.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Определение состояния</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$worker = new Worker();
+$worker->start();
+
+var_dump($worker->isShutdown());
+
+$worker->shutdown();
+
+var_dump($worker->isShutdown());
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+bool(false)
+bool(true)
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/isshutdown.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/isworking.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/isworking.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/isworking.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 343889 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.isworking" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::isWorking</refname>
+  <refpurpose>Определение состояния</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+  <warning>
+   <para>
+    Этот метод был удалён в pthreads v3. Для определения,
+    если ли еще задачи для запуска, нужно использовать
+    метод <methodname>Worker::getStacked</methodname>.
+   </para>
+  </warning>
+ </refsynopsisdiv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>Worker::isWorking</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Определяет, занят ли Worker запуском задач из стека
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &true; или &false;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Определение состояния Worker'а</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$my = new Worker();
+$my->start();
+/* ... */
+if ($my->isWorking()) {
+    /* ... Worker занят запуском другой задачи */
+}
+?>
+]]>
+    </programlisting>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/isworking.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/shutdown.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/shutdown.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/shutdown.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 341654 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.shutdown" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::shutdown</refname>
+  <refpurpose>Остановить Worker</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>Worker::shutdown</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Остановить Worker после запуска всех задач со стека.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Успешно ли остановлен Worker.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Остановка Worker'а</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$my = new Worker();
+$my->start();
+/* stack/execute tasks */
+var_dump($my->shutdown());
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+bool(true)
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/shutdown.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/stack.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/stack.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/stack.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 341654 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.stack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::stack</refname>
+  <refpurpose>Положить задачу на стек</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>Worker::stack</methodname>
+   <methodparam><type>Threaded</type><parameter role="reference">work</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Добавляет задачу на стек заданному Worker'у.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>work</parameter></term>
+    <listitem>
+     <para>
+      Объект типа <classname>Threaded</classname>, который
+      будет запущен Worker'ом.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Новый размер стека.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Помещение задачи на стек Worker'а для её запуска</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$worker = new Worker();
+$work = new class extends Threaded {};
+
+var_dump($worker->stack($work));]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+int(1)
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/stack.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ru/trunk/reference/pthreads/worker/unstack.xml
===================================================================
--- phpdoc/ru/trunk/reference/pthreads/worker/unstack.xml	                        (rev 0)
+++ phpdoc/ru/trunk/reference/pthreads/worker/unstack.xml	2020-04-06 15:12:25 UTC (rev 349629)
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 341654 Maintainer: rjhdby Status: ready -->
+<!-- Reviewed: no -->
+
+<refentry xml:id="worker.unstack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Worker::unstack</refname>
+  <refpurpose>Убрать задачу со стека</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>Worker::unstack</methodname>
+   <void/>
+  </methodsynopsis>
+  <para>
+   Убирает первую задачу (самую старую) из стека.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Новый размер стека.
+  </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>v3</entry>
+       <entry>
+        Убран параметр, в котором указывалась задача для удаления.
+        Теперь всегда удаляется первая задача.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Удаление объектов из стека Worker'а</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$my = new Worker();
+$work = new class extends Threaded {};
+
+var_dump($my->stack($work));
+var_dump($my->unstack());
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+int(1)
+int(0)
+]]>
+    </screen>
+   </example>
+  </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
+-->


Property changes on: phpdoc/ru/trunk/reference/pthreads/worker/unstack.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property