mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
6909677c12
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332961 c90b9560-bf6c-de11-be94-00142212c4b1
88 lines
1.9 KiB
XML
88 lines
1.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Stack Analysis</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>integer</type><methodname>Worker::getStacked</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the number of objects waiting to be executed by the referenced Worker
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An numeric value
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Returns the number of objects currently waiting to be executed by the referenced Worker</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class Work extends Threaded {
|
|
/** ... **/
|
|
|
|
public function run(){
|
|
/** ... **/
|
|
}
|
|
}
|
|
$my = new Worker();
|
|
/** ... **/
|
|
$work = new Work();
|
|
$my->stack($work);
|
|
/** ... **/
|
|
printf("My worker has %d jobs remaining\n", $my->getStacked());
|
|
/** ... **/
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
My worker has 5 jobs remaining
|
|
]]>
|
|
</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
|
|
-->
|