From 95c840f5a84609dcf87b8abc2a9691ead92a7b67 Mon Sep 17 00:00:00 2001
From: Thomas Punt <tpunt@php.net>
Date: Thu, 12 Jan 2017 17:50:11 +0000
Subject: [PATCH] Document the new Worker::collect method

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341649 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pthreads/worker/collect.xml | 104 ++++++++++++++++++++++++++
 1 file changed, 104 insertions(+)
 create mode 100644 reference/pthreads/worker/collect.xml

diff --git a/reference/pthreads/worker/collect.xml b/reference/pthreads/worker/collect.xml
new file mode 100644
index 0000000000..abc6c6c774
--- /dev/null
+++ b/reference/pthreads/worker/collect.xml
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<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>Collect references to completed tasks</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>integer</type><methodname>Worker::collect</methodname>
+   <methodparam choice="opt"><type>Callable</type><parameter>collector</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Allows the worker to collect references determined to be garbage by the
+   optionally given collector.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>collector</parameter></term>
+    <listitem>
+     <para>
+      A Callable collector that returns a boolean on whether the task can be
+      collected or not. Only in rare cases should a custom collector need be
+      used.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The number of remaining tasks on the worker's stack to be collected.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A basic example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$worker = new Worker();
+
+echo "There are currently {$worker->collect()} tasks on the stack to be collected\n";
+
+for ($i = 0; $i < 15; ++$i) {
+    $worker->stack(new class extends Threaded {});
+}
+
+echo "There are {$worker->collect()} tasks remaining on the stack to be collected\n";
+
+$worker->start();
+
+while ($worker->collect()); // blocks until all tasks have finished executing
+
+echo "There are now {$worker->collect()} tasks on the stack to be collected\n";
+
+$worker->shutdown();
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+There are currently 0 tasks on the stack to be collected
+There are 15 tasks remaining on the stack to be collected
+There are now 0 tasks on the stack to be collected
+]]>
+    </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
+-->