mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
02a5c4fd3e
Patch by Michael Bright git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333218 c90b9560-bf6c-de11-be94-00142212c4b1
115 lines
2.9 KiB
XML
115 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="cond.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Cond::wait</refname>
|
|
<refpurpose>Wait for Condition</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>final</modifier>
|
|
<modifier>public</modifier>
|
|
<modifier>static</modifier>
|
|
<type>boolean</type>
|
|
<methodname>Cond::wait</methodname>
|
|
<methodparam>
|
|
<type>long</type>
|
|
<parameter>condition</parameter>
|
|
</methodparam>
|
|
<methodparam>
|
|
<type>long</type>
|
|
<parameter>mutex</parameter>
|
|
</methodparam>
|
|
<methodparam choice="opt">
|
|
<type>long</type>
|
|
<parameter>timeout</parameter>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>Wait for a signal on a Condition Variable, optionally specifying a timeout to limit waiting time.</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>condition</parameter></term>
|
|
<listitem>
|
|
<para>A handle returned by a previous call to <function>Cond::create</function>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mutex</parameter></term>
|
|
<listitem>
|
|
<para>A handle returned by a previous call to <function>Mutex::create</function> and owned (locked) by the caller.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timeout</parameter></term>
|
|
<listitem>
|
|
<para>An optional timeout, in microseconds ( 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>Waiting for Conditions</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/** PLEASE NOTE THIS EXAMPLE WILL CAUSE THE PROCESS TO HANG **/
|
|
$mutex = Mutex::create(true);
|
|
/** You cannot use the "new" keyword, a Cond is not a PHP object **/
|
|
$cond = Cond::create();
|
|
/** The caller must lock the associated Mutex before a call to broadcast **/
|
|
var_dump(Cond::wait($cond, $mutex));
|
|
/** Always destroy Cond you have created **/
|
|
Cond::destroy($cond);
|
|
Mutex::unlock($mutex);
|
|
Mutex::destroy($mutex);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
int(49685473)
|
|
]]>
|
|
</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
|
|
-->
|