php-doc-en/reference/pthreads/worker/unstack.xml
Thomas Punt 99a05eca30 Update pthreads' Worker class docs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341654 c90b9560-bf6c-de11-be94-00142212c4b1
2017-01-12 19:35:17 +00:00

104 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Unstacking work</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Worker::unstack</methodname>
<void/>
</methodsynopsis>
<para>
Removes the first task (the oldest one) in the stack.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The new size of the stack.
</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>
The parameter to specify the task to unstack has been removed. Now, only the
first task in the stack is removed.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Removing objects from the stack of Workers</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
-->