mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
fa352a5cdf
-- Provided by Dai Jie (daijie@php.net) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334685 c90b9560-bf6c-de11-be94-00142212c4b1
95 lines
2.3 KiB
XML
95 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="mutex.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Mutex::lock</refname>
|
|
<refpurpose>Acquire Mutex</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>final</modifier>
|
|
<modifier>public</modifier>
|
|
<modifier>static</modifier>
|
|
<type>boolean</type>
|
|
<methodname>Mutex::lock</methodname>
|
|
<methodparam>
|
|
<type>long</type>
|
|
<parameter>mutex</parameter>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>Attempt to lock the Mutex for the caller.</para>
|
|
<para>An attempt to lock a Mutex owned (locked) by another Thread will result in blocking.</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mutex</parameter></term>
|
|
<listitem>
|
|
<para>A handle returned by a previous call to <function>Mutex::create</function>.</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>Mutex Locking and Unlocking</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/** You cannot use the "new" keyword, a Mutex is not a PHP object **/
|
|
$mutex = Mutex::create();
|
|
/** You can now lock the mutex in any context **/
|
|
var_dump(Mutex::lock($mutex));
|
|
/** It is invalid to attempt to destroy a locked Mutex **/
|
|
var_dump(Mutex::unlock($mutex));
|
|
/** Always destroy mutex you have created **/
|
|
Mutex::destroy($mutex);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
bool(true)
|
|
bool(true)
|
|
]]>
|
|
</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
|
|
-->
|