-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathsetserverparams.xml
More file actions
186 lines (169 loc) · 6.82 KB
/
setserverparams.xml
File metadata and controls
186 lines (169 loc) · 6.82 KB
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f4098e2bac4bcc136b95b85badcf4476fa683477 Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="memcache.setserverparams">
<refnamediv>
<refname>Memcache::setServerParams</refname>
<refname>memcache_set_server_params</refname>
<refpurpose>サーバーのパラメータおよび状態を、実行時に変更する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Memcache::setServerParams</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>11211</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>failure_callback</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>memcache_set_server_params</methodname>
<methodparam><type>Memcache</type><parameter>memcache</parameter></methodparam>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>11211</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>failure_callback</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>Memcache::setServerParams</function> は、
サーバーのパラメータを実行時に変更します。
</simpara>
<note>
<simpara>
この関数は、Memcache バージョン 2.1.0 で追加されました。
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<simpara>
memcached が接続を待ち受けるホストを指定します。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<simpara>
memcached が接続を待ち受けるポートを指定します。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<simpara>
デーモンへの接続の際に使用する値 (秒単位) です。
デフォルト値を 1 秒でも変更する前には十分注意してください。
接続が遅くなってしまうと、 キャッシュ処理のメリットが
なくなってしまいます。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>retry_interval</parameter></term>
<listitem>
<simpara>
サーバーとの接続が失敗した際に再試行を行う頻度を設定します。
デフォルト値は 15 秒です。このパラメータを -1 にすると、
自動的な再試行を行いません。
<function>dl</function> を使用してこの拡張モジュールが動的に
読み込まれている場合は、このパラメータおよび
<parameter>persistent</parameter> は何の効果も及ぼしません。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>status</parameter></term>
<listitem>
<simpara>
サーバーがオンライン状態であるかどうかを制御します。このパラメータを
&false; にし、<parameter>retry_interval</parameter> を -1
と設定すると、失敗したサーバーもコネクションプールに残します。
これにより、キー配布アルゴリズムに影響を与えないようにします。
このサーバーへのリクエストは、フェイルオーバーされるか失敗します。
どちらになるかは <parameter>memcache.allow_failover</parameter>
の設定によって決まります。デフォルトは &true; で、
サーバーがオンライン状態であることを意味します。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>failure_callback</parameter></term>
<listitem>
<simpara>
エラーが発生した際に実行されるコールバック関数を指定できるようにします。
コールバック関数は、フェイルオーバー処理の前に実行されます。
この関数は、ふたつの引数 (ホスト名、失敗したサーバーのポート)
を受け取ります。
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Memcache::setServerParams</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
function _callback_memcache_failure($host, $port) {
print "memcache '$host:$port' failed";
}
/* オブジェクト指向の API */
$memcache = new Memcache;
// サーバーをオフラインモードで追加します
$memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false);
// サーバーをオンラインに変更します
$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');
/* 手続き型の API */
$memcache_obj = memcache_connect('memcache_host', 11211);
memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure');
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>Memcache::addServer</function></member>
<member><function>Memcache::getServerStatus</function></member>
</simplelist>
</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
-->