-
Notifications
You must be signed in to change notification settings - Fork 725
/
ini.xml
614 lines (607 loc) · 22.3 KB
/
ini.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
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="memcached.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Memcached &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.memcached.sess-locking">memcached.sess_locking</link></entry>
<entry>On</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-consistent-hash">memcached.sess_consistent_hash</link></entry>
<entry>On</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.1.0. Default value is On as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-binary">memcached.sess_binary</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.0.0. Replaced by memcached.sess_binary_protocol as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-lock-wait">memcached.sess_lock_wait</link></entry>
<entry>150000</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0. Removed as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-prefix">memcached.sess_prefix</link></entry>
<entry>memc.sess.key.</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-number-of-replicas">memcached.sess_number_of_replicas</link></entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-randomize-replica-read">memcached.sess_randomize_replica_read</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-remove-failed">memcached.sess_remove_failed</link></entry>
<entry>On</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.1.0. Replaced by memcached.sess_remove_failed_servers as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.compression-type">memcached.compression_type</link></entry>
<entry>fastlz</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.compression-factor">memcached.compression_factor</link></entry>
<entry>1.3</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.compression-threshold">memcached.compression_threshold</link></entry>
<entry>2000</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.serializer">memcached.serializer</link></entry>
<entry>igbinary</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 0.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.use-sasl">memcached.use_sasl</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0. Removed as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.default-binary-protocol">memcached.default_binary_protocol</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.default-connect-timeout">memcached.default_connect_timeout</link></entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.default-consistent-hash">memcached.default_consistent_hash</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-binary-protocol">memcached.sess_binary_protocol</link></entry>
<entry>On</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0. Replace memcached.sess_binary.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-connect-timeout">memcached.sess_connect_timeout</link></entry>
<entry>1000</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-consistent-hash-type">memcached.sess_consistent_hash_type</link></entry>
<entry>ketama</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.1.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-lock-expire">memcached.sess_lock_expire</link></entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-lock-retries">memcached.sess_lock_retries</link></entry>
<entry>5</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-lock-wait-max">memcached.sess_lock_wait_max</link></entry>
<entry>150</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0. Default value 150 as of memcached 3.1.0 (previously 2000).</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-lock-wait-min">memcached.sess_lock_wait_min</link></entry>
<entry>150</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0. Default value 150 as of memcached 3.1.0 (previously 1000).</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-persistent">memcached.sess_persistent</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-remove-failed-servers">memcached.sess_remove_failed_servers</link></entry>
<entry>Off</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0. Replace memcached.sess_remove_failed.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-server-failure-limit">memcached.sess_server_failure_limit</link></entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 3.0.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-sasl-password">memcached.sess_sasl_password</link></entry>
<entry>null</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.sess-sasl-username">memcached.sess_sasl_username</link></entry>
<entry>null</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0.</entry>
</row>
<row>
<entry><link linkend="ini.memcached.store-retry-count">memcached.store_retry_count</link></entry>
<entry>2</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of memcached 2.2.0.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.memcached.sess-locking">
<term>
<parameter>memcached.sess_locking</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Use session locking. Valid values: On, Off, the default is On.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-consistent-hash">
<term>
<parameter>memcached.sess_consistent_hash</parameter>
<type>bool</type>
</term>
<listitem>
<para>
If set to On, consistent hashing (libketama) is used for session handling. When consistent hashing is used, one can add or remove cache node(s) without messing up too much with existing keys. Default is On.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-binary">
<term>
<parameter>memcached.sess_binary</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Use memcached session binary mode. Libmemcached replicas only work if
binary mode is enabled. The default is Off.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-lock-wait">
<term>
<parameter>memcached.sess_lock_wait</parameter>
<type>int</type>
</term>
<listitem>
<para>
Session spin lock retry wait time in microseconds. Be careful when
setting this value. Valid values are integers, where 0 is interpreted
as the default value. Negative values result in a reduces locking to a
try lock. The default is 150000.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-prefix">
<term>
<parameter>memcached.sess_prefix</parameter>
<type>string</type>
</term>
<listitem>
<para>
Memcached session key prefix. Valid values are strings less than 219
bytes long. The default value is "memc.sess.key."
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-number-of-replicas">
<term>
<parameter>memcached.sess_number_of_replicas</parameter>
<type>int</type>
</term>
<listitem>
<para>
Write data to a number of additional memcached servers. This is "poor man's HA" as libmemcached calls it. If this value is positive and sess_remove_failed_servers is enabled when a memcached server fails the session will continue to be available from a replica. However, if the failed memcache server becomes available again it will read the session from there which could have old data or no data at all. Default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-randomize-replica-read">
<term>
<parameter>memcached.sess_randomize_replica_read</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Memcached session replica read randomize.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-remove-failed">
<term>
<parameter>memcached.sess_remove_failed</parameter>
<type>int</type>
</term>
<listitem>
<para>
Allow failed memcached server to automatically be removed.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.compression-type">
<term>
<parameter>memcached.compression_type</parameter>
<type>string</type>
</term>
<listitem>
<para>
Set the compression type, valid values are: fastlz, zlib. The default
is fastlz.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.compression-factor">
<term>
<parameter>memcached.compression_factor</parameter>
<type>float</type>
</term>
<listitem>
<para>
Compression factor. Store compressed value only if the compression
factor (saving) exceeds the set limit. Store compressed if:
<literal>plain_len > comp_len * factor</literal>. The default value
is 1.3 (23% space saving).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.compression-threshold">
<term>
<parameter>memcached.compression_threshold</parameter>
<type>int</type>
</term>
<listitem>
<para>
The compression threshold. Do not compress serialized values below this
threshold. The default is 2000 bytes.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.serializer">
<term>
<parameter>memcached.serializer</parameter>
<type>string</type>
</term>
<listitem>
<para>
Set the default serializer for new memcached objects. Valid values
are: php, igbinary, json, json_array, msgpack.
</para>
<variablelist>
<varlistentry>
<term>json</term>
<listitem>
<para>
Standard php JSON encoding. This serializer is fast and compact but
only works on UTF-8 encoded data and does not fully implement
serializing. See the JSON extension. Available as of memcached 0.2.0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>json_array</term>
<listitem>
<para>
As json, but decodes into arrays. Available as of memcached 2.0.0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>php</term>
<listitem>
<para>
The standard PHP serializer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>igbinary</term>
<listitem>
<para>
A binary serializer. Available as of memcached 0.1.4.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>msgpack</term>
<listitem>
<para>
A cross-language binary serializer. Available as of memcached 2.2.0.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The default is igbinary if available, then msgpack if available, then php otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.use-sasl">
<term>
<parameter>memcached.use_sasl</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Use SASL authentication for connections. Valid values: On, Off. The
default is Off.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.default-binary-protocol">
<term>
<parameter>memcached.default_binary_protocol</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Sets the default memcached protocol for new connections. (To configure the memcached protocol for connections used by sessions, use memcached.sess_binary_protocol instead)
If set to On, the memcached binary protocol is used by default. If set to Off, the memcached text protocol is used. Default is Off
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.default-connect-timeout">
<term>
<parameter>memcached.default_connect_timeout</parameter>
<type>int</type>
</term>
<listitem>
<para>
Sets the default memcached connection timeout for new connections. (To configure the memcached connection timeout for sessions, use memcached.sess_connect_timeout instead)
In non-blocking mode this changes the value of the timeout. during socket connection in milliseconds. Specifying -1 means an infinite timeout. Specifying 0 means using the memcached library's default connection timeout. Default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.default-consistent-hash">
<term>
<parameter>memcached.default_consistent_hash</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Sets the default for consistent hashing for new connections. (To configure consistent hashing for session connections, use memcached.sess_consistent_hash instead)
If set to On, consistent hashing (libketama) is used for session handling. When consistent hashing is used, one can add or remove cache node(s) without messing up too much with existing keys default is Off
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-binary-protocol">
<term>
<parameter>memcached.sess_binary_protocol</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Use the memcached binary protocol for memcached sessions (Instead of the text protocol) libmemcached replicas work only if binary mode is enabled. However, certain proxies (such as twemproxy) will work only if the binary protocol is disabled. In older versions of php-memcached, this setting was Off and was called memcached.sess_binary. Default is On with libmemcached 1.0.18 or newer. Default is Off with older version.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-connect-timeout">
<term>
<parameter>memcached.sess_connect_timeout</parameter>
<type>int</type>
</term>
<listitem>
<para>
memcached connect timeout value
In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite timeout.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-consistent-hash-type">
<term>
<parameter>memcached.sess_consistent_hash_type</parameter>
<type>string</type>
</term>
<listitem>
<para>
Memcached session consistent hash type. If set to 'ketama', consistent hashing (libketama) is used for session handling (default for php-memcached 3.x) if set to 'ketama_weighted', weighted consistent hashing (libketama) is used for session handling (default for php-memcached 2.x). Default is "ketama".
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-lock-expire">
<term>
<parameter>memcached.sess_lock_expire</parameter>
<type>int</type>
</term>
<listitem>
<para>
The time, in seconds, before a lock should release itself. Setting to 0 results in the default behaviour, which is to use PHP's max_execution_time. Default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-lock-retries">
<term>
<parameter>memcached.sess_lock_retries</parameter>
<type>int</type>
</term>
<listitem>
<para>
The number of times to retry locking the session lock, not including the first attempt. Default is 5.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-lock-wait-max">
<term>
<parameter>memcached.sess_lock_wait_max</parameter>
<type>int</type>
</term>
<listitem>
<para>
The maximum time, in milliseconds, to wait between session lock attempts. The default is 150.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-lock-wait-min">
<term>
<parameter>memcached.sess_lock_wait_min</parameter>
<type>int</type>
</term>
<listitem>
<para>
The minimum time, in milliseconds, to wait between session lock attempts. This value is double on each lock retry until memcached.sess_lock_wait_max is reached, after which any further retries will take sess_lock_wait_max seconds. The default is 150.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-persistent">
<term>
<parameter>memcached.sess_persistent</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Whether or not to re-use the memcached connections corresponding to the value(s) of session.save_path after the execution of the script ends. Don't use this if certain settings (e.g. SASL settings, sess_binary_protocol) would be overridden between requests. Default is Off.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-remove-failed-servers">
<term>
<parameter>memcached.sess_remove_failed_servers</parameter>
<type>bool</type>
</term>
<listitem>
<para>
Allow failed memcached server to automatically be removed. Default is Off. (In previous versions, this setting was called memcached.sess_remove_failed)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-server-failure-limit">
<term>
<parameter>memcached.sess_server_failure_limit</parameter>
<type>int</type>
</term>
<listitem>
<para>
Set this value to enable the server be removed after configured number of continuous times connection failure. Default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-sasl-password">
<term>
<parameter>memcached.sess_sasl_password</parameter>
<type>string</type>
</term>
<listitem>
<para>
Session SASL password
Both username and password need to be set for SASL to be enabled
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.sess-sasl-username">
<term>
<parameter>memcached.sess_sasl_username</parameter>
<type>string</type>
</term>
<listitem>
<para>
Session SASL username
Both username and password need to be set for SASL to be enabled
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memcached.store-retry-count">
<term>
<parameter>memcached.store_retry_count</parameter>
<type>int</type>
</term>
<listitem>
<para>
The amount of retries for failed store commands.
This mechanism allows transparent fail-over to secondary servers when set/increment/decrement/setMulti operations fail on the desired server in a multi-server environment. the default is 2
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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
-->