<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="stackable.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Stackable::wait</refname>
  <refpurpose>Synchronization</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>Stackable::wait</methodname>
   <methodparam choice="opt"><type>string</type><parameter>timeout</parameter></methodparam>
  </methodsynopsis>
  <para>
  Waits for notification from the Stackable
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
  An optional timeout in millionths of a second.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
  A boolean indication of success
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Notifications and Waiting</title>
    <programlisting role="php">
<![CDATA[
<?php
class Work extends Stackable {
    public function run() {
        $this->synchronized(function($object){
        printf("%s Synchronized\n", __CLASS__);    
        $object->notify();
        }, $this);
    }
}
class My extends Worker {
    public function run() {
        /** ... **/
    }
}

$my = new My();
$my->start();
$work = array(new Work());
$my->stack($work[0]);
/** send notification to the waiting thread **/
$work[0]->synchronized(function($object){
    printf("Process Synchronized\n");
    $object->wait();
}, $work[0]);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Process Synchronized
Work Synchronized
]]>
    </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
-->