-
Notifications
You must be signed in to change notification settings - Fork 58
/
wincache-lock.xml
126 lines (123 loc) · 4.38 KB
/
wincache-lock.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: takagi Status: ready -->
<refentry xml:id="function.wincache-lock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>wincache_lock</refname>
<refpurpose>
指定したキーで排他ロックを確保する
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>wincache_lock</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>isglobal</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
指定したキーについての排他ロックを確保します。
ロックを確保するまでは、現在のスクリプトの実行はブロックされます。
ロックを確保できたら、その後は他のスクリプトから同じキーのロックを要求があってもそれをブロックします。
現在のスクリプトが <function>wincache_unlock</function> でロックを解放するまでは他のスクリプトからロックを確保できません。
</para>
<warning>
<simpara>
<function>wincache_lock</function> および <function>wincache_unlock</function>
を使っていると、FastCGI のようなマルチプロセス環境において PHP スクリプトがデッドロックを引き起こすことがあります。
本当にそれが必要である場合でない限り、これらの関数は使わないようにしましょう。
キャッシュ上でのさまざまな操作の大半は、これらの関数を使う必要のないものです。
</simpara>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
ロックを取得したいキャッシュ内のキーの名前。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isglobal</parameter></term>
<listitem>
<para>
ロックのスコープをシステム全体にするかローカルにするかを制御します。
ローカルロックのスコープは、IIS FastCGI のアプリケーションプール内
あるいは同一の親プロセス ID を持つ PHP プロセス群全体となります。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>wincache_lock</function> の使用</title>
<programlisting role="php">
<![CDATA[
<?php
$fp = fopen("/tmp/lock.txt", "r+");
if (wincache_lock(“lock_txt_lock”)) { // 排他ロックを確保します
ftruncate($fp, 0); // ファイルを切り詰めます
fwrite($fp, "Write something here\n");
wincache_unlock(“lock_txt_lock”); // ロックを解放します
} else {
echo "Couldn't get the lock!";
}
fclose($fp);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>wincache_unlock</function></member>
<member><function>wincache_ucache_set</function></member>
<member><function>wincache_ucache_get</function></member>
<member><function>wincache_ucache_delete</function></member>
<member><function>wincache_ucache_clear</function></member>
<member><function>wincache_ucache_exists</function></member>
<member><function>wincache_ucache_meminfo</function></member>
<member><function>wincache_ucache_info</function></member>
<member><function>wincache_scache_info</function></member>
</simplelist>
</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
-->