reference/memcached/ini.xml
d4d5216e7a965ca194f6b1c9dee84cecab2674e5
...
...
@@ -19,81 +19,181 @@
19
19
<tbody>
20
20
<row>
21
21
<entry><link linkend="ini.memcached.sess-locking">memcached.sess_locking</link></entry>
22
-
<entry>1</entry>
23
-
<entry>PHP_INI_ALL</entry>
24
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
22
+
<entry>On</entry>
23
+
<entry><constant>INI_ALL</constant></entry>
24
+
<entry>Available as of memcached 0.1.0.</entry>
25
25
</row>
26
26
<row>
27
27
<entry><link linkend="ini.memcached.sess-consistent-hash">memcached.sess_consistent_hash</link></entry>
28
-
<entry>0</entry>
29
-
<entry>PHP_INI_ALL</entry>
30
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
28
+
<entry>On</entry>
29
+
<entry><constant>INI_ALL</constant></entry>
30
+
<entry>Available as of memcached 2.1.0. Default value is <literal>On</literal> as of memcached 3.0.0.</entry>
31
31
</row>
32
32
<row>
33
33
<entry><link linkend="ini.memcached.sess-binary">memcached.sess_binary</link></entry>
34
-
<entry>0</entry>
35
-
<entry>PHP_INI_ALL</entry>
36
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
34
+
<entry>Off</entry>
35
+
<entry><constant>INI_ALL</constant></entry>
36
+
<entry>Available as of memcached 2.0.0. Replaced by <literal>memcached.sess_binary_protocol</literal> as of memcached 3.0.0.</entry>
37
37
</row>
38
38
<row>
39
39
<entry><link linkend="ini.memcached.sess-lock-wait">memcached.sess_lock_wait</link></entry>
40
40
<entry>150000</entry>
41
-
<entry>PHP_INI_ALL</entry>
42
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
41
+
<entry><constant>INI_ALL</constant></entry>
42
+
<entry>Available as of memcached 0.1.0. Removed as of memcached 3.0.0.</entry>
43
43
</row>
44
44
<row>
45
45
<entry><link linkend="ini.memcached.sess-prefix">memcached.sess_prefix</link></entry>
46
46
<entry>memc.sess.key.</entry>
47
-
<entry>PHP_INI_ALL</entry>
48
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
47
+
<entry><constant>INI_ALL</constant></entry>
48
+
<entry>Available as of memcached 0.1.0.</entry>
49
49
</row>
50
50
<row>
51
51
<entry><link linkend="ini.memcached.sess-number-of-replicas">memcached.sess_number_of_replicas</link></entry>
52
52
<entry>0</entry>
53
-
<entry>PHP_INI_ALL</entry>
54
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
53
+
<entry><constant>INI_ALL</constant></entry>
54
+
<entry>Available as of memcached 2.1.0.</entry>
55
55
</row>
56
56
<row>
57
57
<entry><link linkend="ini.memcached.sess-randomize-replica-read">memcached.sess_randomize_replica_read</link></entry>
58
-
<entry>0</entry>
59
-
<entry>PHP_INI_ALL</entry>
60
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
58
+
<entry>Off</entry>
59
+
<entry><constant>INI_ALL</constant></entry>
60
+
<entry>Available as of memcached 2.1.0.</entry>
61
61
</row>
62
62
<row>
63
63
<entry><link linkend="ini.memcached.sess-remove-failed">memcached.sess_remove_failed</link></entry>
64
-
<entry>0</entry>
65
-
<entry>PHP_INI_ALL</entry>
66
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
64
+
<entry>On</entry>
65
+
<entry><constant>INI_ALL</constant></entry>
66
+
<entry>Available as of memcached 2.1.0. Replaced by <literal>memcached.sess_remove_failed_servers</literal> as of memcached 3.0.0.</entry>
67
67
</row>
68
68
<row>
69
69
<entry><link linkend="ini.memcached.compression-type">memcached.compression_type</link></entry>
70
70
<entry>fastlz</entry>
71
-
<entry>PHP_INI_ALL</entry>
72
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
71
+
<entry><constant>INI_ALL</constant></entry>
72
+
<entry>Available as of memcached 0.1.0.</entry>
73
73
</row>
74
74
<row>
75
75
<entry><link linkend="ini.memcached.compression-factor">memcached.compression_factor</link></entry>
76
76
<entry>1.3</entry>
77
-
<entry>PHP_INI_ALL</entry>
78
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
77
+
<entry><constant>INI_ALL</constant></entry>
78
+
<entry>Available as of memcached 0.1.0.</entry>
79
79
</row>
80
80
<row>
81
81
<entry><link linkend="ini.memcached.compression-threshold">memcached.compression_threshold</link></entry>
82
82
<entry>2000</entry>
83
-
<entry>PHP_INI_ALL</entry>
84
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
83
+
<entry><constant>INI_ALL</constant></entry>
84
+
<entry>Available as of memcached 0.1.0.</entry>
85
85
</row>
86
86
<row>
87
87
<entry><link linkend="ini.memcached.serializer">memcached.serializer</link></entry>
88
-
<entry>php</entry>
89
-
<entry>PHP_INI_ALL</entry>
90
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
88
+
<entry>igbinary</entry>
89
+
<entry><constant>INI_ALL</constant></entry>
90
+
<entry>Available as of memcached 0.1.0.</entry>
91
91
</row>
92
92
<row>
93
93
<entry><link linkend="ini.memcached.use-sasl">memcached.use_sasl</link></entry>
94
+
<entry>Off</entry>
95
+
<entry><constant>INI_ALL</constant></entry>
96
+
<entry>Available as of memcached 2.2.0. Removed as of memcached 3.0.0.</entry>
97
+
</row>
98
+
<row>
99
+
<entry><link linkend="ini.memcached.default-binary-protocol">memcached.default_binary_protocol</link></entry>
100
+
<entry>Off</entry>
101
+
<entry><constant>INI_ALL</constant></entry>
102
+
<entry>Available as of memcached 3.0.0.</entry>
103
+
</row>
104
+
<row>
105
+
<entry><link linkend="ini.memcached.default-connect-timeout">memcached.default_connect_timeout</link></entry>
106
+
<entry>0</entry>
107
+
<entry><constant>INI_ALL</constant></entry>
108
+
<entry>Available as of memcached 3.0.0.</entry>
109
+
</row>
110
+
<row>
111
+
<entry><link linkend="ini.memcached.default-consistent-hash">memcached.default_consistent_hash</link></entry>
112
+
<entry>Off</entry>
113
+
<entry><constant>INI_ALL</constant></entry>
114
+
<entry>Available as of memcached 3.0.0.</entry>
115
+
</row>
116
+
<row>
117
+
<entry><link linkend="ini.memcached.sess-binary-protocol">memcached.sess_binary_protocol</link></entry>
118
+
<entry>On</entry>
119
+
<entry><constant>INI_ALL</constant></entry>
120
+
<entry>Available as of memcached 3.0.0. Replace <literal>memcached.sess_binary</literal>.</entry>
121
+
</row>
122
+
<row>
123
+
<entry><link linkend="ini.memcached.sess-connect-timeout">memcached.sess_connect_timeout</link></entry>
124
+
<entry>1000</entry>
125
+
<entry><constant>INI_ALL</constant></entry>
126
+
<entry>Available as of memcached 2.2.0.</entry>
127
+
</row>
128
+
<row>
129
+
<entry><link linkend="ini.memcached.sess-consistent-hash-type">memcached.sess_consistent_hash_type</link></entry>
130
+
<entry>ketama</entry>
131
+
<entry><constant>INI_ALL</constant></entry>
132
+
<entry>Available as of memcached 3.1.0.</entry>
133
+
</row>
134
+
<row>
135
+
<entry><link linkend="ini.memcached.sess-lock-expire">memcached.sess_lock_expire</link></entry>
136
+
<entry>0</entry>
137
+
<entry><constant>INI_ALL</constant></entry>
138
+
<entry>Available as of memcached 2.2.0.</entry>
139
+
</row>
140
+
<row>
141
+
<entry><link linkend="ini.memcached.sess-lock-retries">memcached.sess_lock_retries</link></entry>
142
+
<entry>5</entry>
143
+
<entry><constant>INI_ALL</constant></entry>
144
+
<entry>Available as of memcached 3.0.0.</entry>
145
+
</row>
146
+
<row>
147
+
<entry><link linkend="ini.memcached.sess-lock-wait-max">memcached.sess_lock_wait_max</link></entry>
148
+
<entry>150</entry>
149
+
<entry><constant>INI_ALL</constant></entry>
150
+
<entry>Available as of memcached 3.0.0. Default value <literal>150</literal> as of memcached 3.1.0 (previously <literal>2000</literal>).</entry>
151
+
</row>
152
+
<row>
153
+
<entry><link linkend="ini.memcached.sess-lock-wait-min">memcached.sess_lock_wait_min</link></entry>
154
+
<entry>150</entry>
155
+
<entry><constant>INI_ALL</constant></entry>
156
+
<entry>Available as of memcached 3.0.0. Default value <literal>150</literal> as of memcached 3.1.0 (previously <literal>1000</literal>).</entry>
157
+
</row>
158
+
<row>
159
+
<entry><link linkend="ini.memcached.sess-persistent">memcached.sess_persistent</link></entry>
160
+
<entry>Off</entry>
161
+
<entry><constant>INI_ALL</constant></entry>
162
+
<entry>Available as of memcached 3.0.0.</entry>
163
+
</row>
164
+
<row>
165
+
<entry><link linkend="ini.memcached.sess-remove-failed-servers">memcached.sess_remove_failed_servers</link></entry>
166
+
<entry>Off</entry>
167
+
<entry><constant>INI_ALL</constant></entry>
168
+
<entry>Available as of memcached 3.0.0. Replace <literal>memcached.sess_remove_failed</literal>.</entry>
169
+
</row>
170
+
<row>
171
+
<entry><link linkend="ini.memcached.sess-server-failure-limit">memcached.sess_server_failure_limit</link></entry>
172
+
<entry>0</entry>
173
+
<entry><constant>INI_ALL</constant></entry>
174
+
<entry>Available as of memcached 3.0.0.</entry>
175
+
</row>
176
+
<row>
177
+
<entry><link linkend="ini.memcached.sess-sasl-password">memcached.sess_sasl_password</link></entry>
178
+
<entry>null</entry>
179
+
<entry><constant>INI_ALL</constant></entry>
180
+
<entry>Available as of memcached 2.2.0.</entry>
181
+
</row>
182
+
<row>
183
+
<entry><link linkend="ini.memcached.sess-sasl-username">memcached.sess_sasl_username</link></entry>
184
+
<entry>null</entry>
185
+
<entry><constant>INI_ALL</constant></entry>
186
+
<entry>Available as of memcached 2.2.0.</entry>
187
+
</row>
188
+
<row>
189
+
<entry><link linkend="ini.memcached.store-retry-count">memcached.store_retry_count</link></entry>
94
190
<entry>0</entry>
95
-
<entry>PHP_INI_SYSTEM</entry>
96
-
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
191
+
<entry><constant>INI_ALL</constant></entry>
192
+
<entry>
193
+
Available as of memcached 2.2.0.
194
+
Default value <literal>0</literal> as of memcached 3.2.0
195
+
(previously <literal>2</literal>).
196
+
</entry>
97
197
</row>
98
198
</tbody>
99
199
</tgroup>
...
...
@@ -104,62 +204,57 @@
104
204

105
205
<para>
106
206
<variablelist>
107
-

108
207
<varlistentry xml:id="ini.memcached.sess-locking">
109
208
<term>
110
209
<parameter>memcached.sess_locking</parameter>
111
-
<type>integer</type>
210
+
<type>bool</type>
112
211
</term>
113
212
<listitem>
114
213
<para>
115
-
Use session locking. Valid values: On, Off, the default is On.
214
+
Use session locking. Valid values: <literal>On</literal>, <literal>Off</literal>, the default is <literal>On</literal>.
116
215
</para>
117
216
</listitem>
118
217
</varlistentry>
119
-

120
218
<varlistentry xml:id="ini.memcached.sess-consistent-hash">
121
219
<term>
122
220
<parameter>memcached.sess_consistent_hash</parameter>
123
-
<type>integer</type>
221
+
<type>bool</type>
124
222
</term>
125
223
<listitem>
126
224
<para>
127
-
Memcached session consistent hash mode. If set to On, consistent
128
-
hashing is used for session handling. When consistent hashing is used,
129
-
one can add or remove cache node(s) without messing up too much with
130
-
existing keys. The default is Off.
225
+
If set to <literal>On</literal>, consistent hashing (libketama) is used for session handling.
226
+
When consistent hashing is used,
227
+
one can add or remove cache node(s) without messing up too much with existing keys.
228
+
Default is <literal>On</literal>.
131
229
</para>
132
230
</listitem>
133
231
</varlistentry>
134
-

135
232
<varlistentry xml:id="ini.memcached.sess-binary">
136
233
<term>
137
234
<parameter>memcached.sess_binary</parameter>
138
-
<type>integer</type>
235
+
<type>bool</type>
139
236
</term>
140
237
<listitem>
141
238
<para>
142
239
Use memcached session binary mode. Libmemcached replicas only work if
143
-
binary mode is enabled. The default is Off.
240
+
binary mode is enabled. The default is <literal>Off</literal>.
144
241
</para>
145
242
</listitem>
146
243
</varlistentry>
147
-

148
244
<varlistentry xml:id="ini.memcached.sess-lock-wait">
149
245
<term>
150
246
<parameter>memcached.sess_lock_wait</parameter>
151
-
<type>integer</type>
247
+
<type>int</type>
152
248
</term>
153
249
<listitem>
154
250
<para>
155
-
Session spin lock retry wait time in microseconds. Be carefull when
156
-
setting this value. Valid values are integers, where 0 is interpreted
251
+
Session spin lock retry wait time in microseconds. Be careful when
252
+
setting this value. Valid values are integers, where <literal>0</literal> is interpreted
157
253
as the default value. Negative values result in a reduces locking to a
158
-
try lock. The default is 150000.
254
+
try lock. The default is <literal>150000</literal>.
159
255
</para>
160
256
</listitem>
161
257
</varlistentry>
162
-

163
258
<varlistentry xml:id="ini.memcached.sess-prefix">
164
259
<term>
165
260
<parameter>memcached.sess_prefix</parameter>
...
...
@@ -168,27 +263,30 @@
168
263
<listitem>
169
264
<para>
170
265
Memcached session key prefix. Valid values are strings less than 219
171
-
bytes long. The default value is "memc.sess.key."
266
+
bytes long. The default value is <literal>memc.sess.key</literal>.
172
267
</para>
173
268
</listitem>
174
269
</varlistentry>
175
-

176
270
<varlistentry xml:id="ini.memcached.sess-number-of-replicas">
177
271
<term>
178
272
<parameter>memcached.sess_number_of_replicas</parameter>
179
-
<type>integer</type>
273
+
<type>int</type>
180
274
</term>
181
275
<listitem>
182
276
<para>
183
-
The memcached session number of replicas.
277
+
Write data to a number of additional memcached servers. This is "poor man's HA" as libmemcached calls it.
278
+
If this value is positive and <literal>sess_remove_failed_servers</literal> is enabled
279
+
when a memcached server fails the session will continue to be available from a replica.
280
+
However, if the failed memcache server becomes available again it will read the session
281
+
from there which could have old data or no data at all.
282
+
Default is <literal>0</literal>.
184
283
</para>
185
284
</listitem>
186
285
</varlistentry>
187
-

188
286
<varlistentry xml:id="ini.memcached.sess-randomize-replica-read">
189
287
<term>
190
288
<parameter>memcached.sess_randomize_replica_read</parameter>
191
-
<type>integer</type>
289
+
<type>bool</type>
192
290
</term>
193
291
<listitem>
194
292
<para>
...
...
@@ -196,11 +294,10 @@
196
294
</para>
197
295
</listitem>
198
296
</varlistentry>
199
-

200
297
<varlistentry xml:id="ini.memcached.sess-remove-failed">
201
298
<term>
202
299
<parameter>memcached.sess_remove_failed</parameter>
203
-
<type>integer</type>
300
+
<type>int</type>
204
301
</term>
205
302
<listitem>
206
303
<para>
...
...
@@ -208,7 +305,6 @@
208
305
</para>
209
306
</listitem>
210
307
</varlistentry>
211
-

212
308
<varlistentry xml:id="ini.memcached.compression-type">
213
309
<term>
214
310
<parameter>memcached.compression_type</parameter>
...
...
@@ -216,12 +312,11 @@
216
312
</term>
217
313
<listitem>
218
314
<para>
219
-
Set the compression type, valid values are: fastlz, zlib. The default
220
-
is fastlz.
315
+
Set the compression type, valid values are: <literal>fastlz</literal>, <literal>zlib</literal>.
316
+
The default is <literal>fastlz</literal>.
221
317
</para>
222
318
</listitem>
223
319
</varlistentry>
224
-

225
320
<varlistentry xml:id="ini.memcached.compression-factor">
226
321
<term>
227
322
<parameter>memcached.compression_factor</parameter>
...
...
@@ -232,24 +327,22 @@
232
327
Compression factor. Store compressed value only if the compression
233
328
factor (saving) exceeds the set limit. Store compressed if:
234
329
<literal>plain_len &gt; comp_len * factor</literal>. The default value
235
-
is 1.3 (23% space saving).
330
+
is <literal>1.3</literal> (23% space saving).
236
331
</para>
237
332
</listitem>
238
333
</varlistentry>
239
-

240
334
<varlistentry xml:id="ini.memcached.compression-threshold">
241
335
<term>
242
336
<parameter>memcached.compression_threshold</parameter>
243
-
<type>integer</type>
337
+
<type>int</type>
244
338
</term>
245
339
<listitem>
246
340
<para>
247
341
The compression threshold. Do not compress serialized values below this
248
-
threshold. The default is 2000 bytes.
342
+
threshold. The default is <literal>2000</literal> bytes.
249
343
</para>
250
344
</listitem>
251
345
</varlistentry>
252
-

253
346
<varlistentry xml:id="ini.memcached.serializer">
254
347
<term>
255
348
<parameter>memcached.serializer</parameter>
...
...
@@ -258,16 +351,17 @@
258
351
<listitem>
259
352
<para>
260
353
Set the default serializer for new memcached objects. Valid values
261
-
are: php, igbinary, json, json_array.
354
+
are: <literal>php</literal>, <literal>igbinary</literal>, <literal>json</literal>,
355
+
<literal>json_array</literal>, <literal>msgpack</literal>.
262
356
</para>
263
357
<variablelist>
264
358
<varlistentry>
265
359
<term>json</term>
266
360
<listitem>
267
361
<para>
268
-
Standard php JSON encoding. This serializer is fast and compact but
362
+
Standard PHP JSON encoding. This serializer is fast and compact but
269
363
only works on UTF-8 encoded data and does not fully implement
270
-
serializing. See the JSON extension.
364
+
serializing. See the JSON extension. Available as of memcached 0.2.0.
271
365
</para>
272
366
</listitem>
273
367
</varlistentry>
...
...
@@ -275,7 +369,7 @@
275
369
<term>json_array</term>
276
370
<listitem>
277
371
<para>
278
-
As json, but decodes into arrays.
372
+
As <literal>json</literal>, but decodes into arrays. Available as of memcached 2.0.0.
279
373
</para>
280
374
</listitem>
281
375
</varlistentry>
...
...
@@ -291,30 +385,277 @@
291
385
<term>igbinary</term>
292
386
<listitem>
293
387
<para>
294
-
A binary serializer
388
+
A binary serializer. Available as of memcached 0.1.4.
389
+
</para>
390
+
</listitem>
391
+
</varlistentry>
392
+
<varlistentry>
393
+
<term>msgpack</term>
394
+
<listitem>
395
+
<para>
396
+
A cross-language binary serializer. Available as of memcached 2.2.0.
295
397
</para>
296
398
</listitem>
297
399
</varlistentry>
298
400
</variablelist>
299
401
<para>
300
-
The default is igbinary if available and php otherwise.
402
+
The default is <literal>igbinary</literal> if available, then <literal>msgpack</literal> if
403
+
available, then <literal>php</literal> otherwise.
301
404
</para>
302
405
</listitem>
303
406
</varlistentry>
304
-

305
407
<varlistentry xml:id="ini.memcached.use-sasl">
306
408
<term>
307
409
<parameter>memcached.use_sasl</parameter>
308
-
<type>integer</type>
410
+
<type>bool</type>
411
+
</term>
412
+
<listitem>
413
+
<para>
414
+
Use SASL authentication for connections. Valid values: <literal>On</literal>, <literal>Off</literal>. The
415
+
default is <literal>Off</literal>.
416
+
</para>
417
+
</listitem>
418
+
</varlistentry>
419
+
<varlistentry xml:id="ini.memcached.default-binary-protocol">
420
+
<term>
421
+
<parameter>memcached.default_binary_protocol</parameter>
422
+
<type>bool</type>
423
+
</term>
424
+
<listitem>
425
+
<para>
426
+
Sets the default memcached protocol for new connections. (To configure the memcached protocol for
427
+
connections used by sessions, use <literal>memcached.sess_binary_protocol</literal> instead.)
428
+

429
+
If set to <literal>On</literal>, the memcached binary protocol is used by default.
430
+
If set to <literal>Off</literal>, the memcached text protocol is used.
431
+
Default is <literal>Off</literal>.
432
+
</para>
433
+
</listitem>
434
+
</varlistentry>
435
+
<varlistentry xml:id="ini.memcached.default-connect-timeout">
436
+
<term>
437
+
<parameter>memcached.default_connect_timeout</parameter>
438
+
<type>int</type>
309
439
</term>
310
440
<listitem>
311
441
<para>
312
-
Use SASL authentication for connections. Valid values: On, Off. The
313
-
default is Off.
442
+
Sets the default memcached connection timeout for new connections.
443
+
(To configure the memcached connection timeout for sessions, use <literal>memcached.sess_connect_timeout</literal> instead.)
444
+

445
+
In non-blocking mode this changes the value of the timeout.
446
+
During socket connection in milliseconds.
447
+
Specifying <literal>-1</literal> means an infinite timeout.
448
+
Specifying <literal>0</literal> means using the memcached library's default connection timeout.
449
+
Default is <literal>0</literal>.
314
450
</para>
315
451
</listitem>
316
452
</varlistentry>
453
+
<varlistentry xml:id="ini.memcached.default-consistent-hash">
454
+
<term>
455
+
<parameter>memcached.default_consistent_hash</parameter>
456
+
<type>bool</type>
457
+
</term>
458
+
<listitem>
459
+
<para>
460
+
Sets the default for consistent hashing for new connections.
461
+
(To configure consistent hashing for session connections,
462
+
use <literal>memcached.sess_consistent_hash</literal> instead.)
317
463

464
+
If set to <literal>On</literal>, consistent hashing (libketama) is used for
465
+
session handling. When consistent hashing is used, one can add or remove cache node(s)
466
+
without messing up too much with existing keys default is <literal>Off</literal>.
467
+
</para>
468
+
</listitem>
469
+
</varlistentry>
470
+
<varlistentry xml:id="ini.memcached.sess-binary-protocol">
471
+
<term>
472
+
<parameter>memcached.sess_binary_protocol</parameter>
473
+
<type>bool</type>
474
+
</term>
475
+
<listitem>
476
+
<para>
477
+
Use the memcached binary protocol for memcached sessions instead of the text protocol.
478
+
libmemcached replicas only work if the binary mode is enabled.
479
+
However, certain proxies (such as twemproxy) will only work if the binary protocol is disabled.
480
+
Default is <literal>On</literal> as of libmemcached 1.0.18.
481
+
Prior to libmemcached 1.0.18, the default was <literal>Off</literal>.
482
+
</para>
483
+
<note>
484
+
<simpara>
485
+
In previous versions of php-memcached, this setting was called
486
+
<literal>memcached.sess_binary</literal>.
487
+
</simpara>
488
+
</note>
489
+
</listitem>
490
+
</varlistentry>
491
+
<varlistentry xml:id="ini.memcached.sess-connect-timeout">
492
+
<term>
493
+
<parameter>memcached.sess_connect_timeout</parameter>
494
+
<type>int</type>
495
+
</term>
496
+
<listitem>
497
+
<para>
498
+
memcached connect timeout value
499
+
In non-blocking mode this changes the value of the timeout
500
+
during socket connection in milliseconds.
501
+
Specifying <literal>-1</literal> means an infinite timeout.
502
+
</para>
503
+
</listitem>
504
+
</varlistentry>
505
+
<varlistentry xml:id="ini.memcached.sess-consistent-hash-type">
506
+
<term>
507
+
<parameter>memcached.sess_consistent_hash_type</parameter>
508
+
<type>string</type>
509
+
</term>
510
+
<listitem>
511
+
<para>
512
+
Memcached session consistent hash type.
513
+
If set to <literal>ketama</literal>, consistent hashing (libketama)
514
+
is used for session handling.
515
+
If set to <literal>ketama_weighted</literal>, weighted consistent hashing (libketama)
516
+
is used for session handling.
517
+
Default is <literal>ketama</literal>.
518
+
Prior to php-memcached 3.0, the default was <literal>ketama_weighted</literal>.
519
+
</para>
520
+
</listitem>
521
+
</varlistentry>
522
+
<varlistentry xml:id="ini.memcached.sess-lock-expire">
523
+
<term>
524
+
<parameter>memcached.sess_lock_expire</parameter>
525
+
<type>int</type>
526
+
</term>
527
+
<listitem>
528
+
<para>
529
+
The time, in seconds, before a lock should release itself.
530
+
Setting to <literal>0</literal> results in the default behaviour,
531
+
which is to use PHP's <literal>max_execution_time</literal>.
532
+
Default is <literal>0</literal>.
533
+
</para>
534
+
</listitem>
535
+
</varlistentry>
536
+
<varlistentry xml:id="ini.memcached.sess-lock-retries">
537
+
<term>
538
+
<parameter>memcached.sess_lock_retries</parameter>
539
+
<type>int</type>
540
+
</term>
541
+
<listitem>
542
+
<para>
543
+
The number of times to retry locking the session lock, not including the first attempt.
544
+
Default is <literal>5</literal>.
545
+
</para>
546
+
</listitem>
547
+
</varlistentry>
548
+
<varlistentry xml:id="ini.memcached.sess-lock-wait-max">
549
+
<term>
550
+
<parameter>memcached.sess_lock_wait_max</parameter>
551
+
<type>int</type>
552
+
</term>
553
+
<listitem>
554
+
<para>
555
+
The maximum time, in milliseconds, to wait between session lock attempts.
556
+
The default is <literal>150</literal>.
557
+
</para>
558
+
</listitem>
559
+
</varlistentry>
560
+
<varlistentry xml:id="ini.memcached.sess-lock-wait-min">
561
+
<term>
562
+
<parameter>memcached.sess_lock_wait_min</parameter>
563
+
<type>int</type>
564
+
</term>
565
+
<listitem>
566
+
<para>
567
+
The minimum time, in milliseconds, to wait between session lock attempts.
568
+
This value is double on each lock retry until <literal>memcached.sess_lock_wait_max</literal> is
569
+
reached, after which any further retries will take
570
+
<literal>memcached.sess_lock_wait_max</literal> seconds.
571
+
The default is <literal>150</literal>.
572
+
</para>
573
+
</listitem>
574
+
</varlistentry>
575
+
<varlistentry xml:id="ini.memcached.sess-persistent">
576
+
<term>
577
+
<parameter>memcached.sess_persistent</parameter>
578
+
<type>bool</type>
579
+
</term>
580
+
<listitem>
581
+
<para>
582
+
Whether or not to re-use the memcached connections corresponding to the value(s) of
583
+
<literal>session.save_path</literal> after the execution of the script ends. Don't use this if
584
+
certain settings (e.g. SASL settings, sess_binary_protocol) would be overridden between requests.
585
+
Default is <literal>Off</literal>.
586
+
</para>
587
+
</listitem>
588
+
</varlistentry>
589
+
<varlistentry xml:id="ini.memcached.sess-remove-failed-servers">
590
+
<term>
591
+
<parameter>memcached.sess_remove_failed_servers</parameter>
592
+
<type>bool</type>
593
+
</term>
594
+
<listitem>
595
+
<para>
596
+
Allow failed memcached server to automatically be removed.
597
+
Default is <literal>Off</literal>.
598
+
</para>
599
+
<note>
600
+
<simpara>
601
+
In previous versions of php-memcached, this setting was called
602
+
<literal>memcached.sess_remove_failed</literal>.
603
+
</simpara>
604
+
</note>
605
+
</listitem>
606
+
</varlistentry>
607
+
<varlistentry xml:id="ini.memcached.sess-server-failure-limit">
608
+
<term>
609
+
<parameter>memcached.sess_server_failure_limit</parameter>
610
+
<type>int</type>
611
+
</term>
612
+
<listitem>
613
+
<para>
614
+
Set this value to enable the server be removed after
615
+
configured number of continuous times connection failure.
616
+
Default is <literal>0</literal>.
617
+
</para>
618
+
</listitem>
619
+
</varlistentry>
620
+
<varlistentry xml:id="ini.memcached.sess-sasl-password">
621
+
<term>
622
+
<parameter>memcached.sess_sasl_password</parameter>
623
+
<type>string</type>
624
+
</term>
625
+
<listitem>
626
+
<para>
627
+
Session SASL password.
628
+
Both username and password need to be set for SASL to be enabled.
629
+
</para>
630
+
</listitem>
631
+
</varlistentry>
632
+
<varlistentry xml:id="ini.memcached.sess-sasl-username">
633
+
<term>
634
+
<parameter>memcached.sess_sasl_username</parameter>
635
+
<type>string</type>
636
+
</term>
637
+
<listitem>
638
+
<para>
639
+
Session SASL username.
640
+
Both username and password need to be set for SASL to be enabled.
641
+
</para>
642
+
</listitem>
643
+
</varlistentry>
644
+
<varlistentry xml:id="ini.memcached.store-retry-count">
645
+
<term>
646
+
<parameter>memcached.store_retry_count</parameter>
647
+
<type>int</type>
648
+
</term>
649
+
<listitem>
650
+
<para>
651
+
The amount of retries for failed store commands.
652
+
This mechanism allows transparent fail-over to secondary servers when
653
+
set/increment/decrement/setMulti operations fail on
654
+
the desired server in a multi-server environment.
655
+
The default is <literal>2</literal>.
656
+
</para>
657
+
</listitem>
658
+
</varlistentry>
318
659
</variablelist>
319
660
</para>
320
661
</section>
321
662



Tools (Chinese (Simplified) Manual)