/
constants.xml
510 lines (449 loc) · 18.5 KB
/
constants.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="memcached.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry xml:id="memcached.constants.opt-compression">
<term><constant>Memcached::OPT_COMPRESSION</constant></term>
<listitem>
<para>Enables or disables payload compression. When enabled,
item values longer than a certain threshold (currently 100 bytes) will be
compressed during storage and decompressed during retrieval
transparently.</para>
<para>Type: <literal>boolean</literal>, default: &true;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-serializer">
<term><constant>Memcached::OPT_SERIALIZER</constant></term>
<listitem>
<para>
Specifies the serializer to use for serializing non-scalar values.
The valid serializers are <constant>Memcached::SERIALIZER_PHP</constant>
or <constant>Memcached::SERIALIZER_IGBINARY</constant>. The latter is
supported only when memcached is configured with
<literal>--enable-memcached-igbinary</literal> option and the
<literal>igbinary</literal> extension is loaded.
</para>
<para>Type: <literal>integer</literal>, default: <constant>Memcached::SERIALIZER_PHP</constant>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.serializer-php">
<term><constant>Memcached::SERIALIZER_PHP</constant></term>
<listitem>
<para>The default PHP serializer.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.serializer-igbinary">
<term><constant>Memcached::SERIALIZER_IGBINARY</constant></term>
<listitem>
<para>The <link xlink:href="&url.igbinary;">igbinary</link> serializer.
Instead of textual representation it stores PHP data structures in a
compact binary form, resulting in space and time gains.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.serializer-json">
<term><constant>Memcached::SERIALIZER_JSON</constant></term>
<listitem>
<para>The JSON serializer. Requires PHP 5.2.10+.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-prefix-key">
<term><constant>Memcached::OPT_PREFIX_KEY</constant></term>
<listitem>
<para>This can be used to create a "domain" for your item keys. The value
specified here will be prefixed to each of the keys. It cannot be
longer than <literal>128</literal> characters and will reduce the
maximum available key size. The prefix is applied only to the item keys,
not to the server keys.</para>
<para>Type: <literal>string</literal>, default: <literal>""</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-hash">
<term><constant>Memcached::OPT_HASH</constant></term>
<listitem>
<para>Specifies the hashing algorithm used for the item keys. The valid
values are supplied via <constant>Memcached::HASH_*</constant> constants.
Each hash algorithm has its advantages and its disadvantages. Go with the
default if you don't know or don't care.</para>
<para>Type: <literal>integer</literal>, default: <constant>Memcached::HASH_DEFAULT</constant></para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-default">
<term><constant>Memcached::HASH_DEFAULT</constant></term>
<listitem>
<para>The default (Jenkins one-at-a-time) item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-md5">
<term><constant>Memcached::HASH_MD5</constant></term>
<listitem>
<para>MD5 item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-crc">
<term><constant>Memcached::HASH_CRC</constant></term>
<listitem>
<para>CRC item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-fnv1-64">
<term><constant>Memcached::HASH_FNV1_64</constant></term>
<listitem>
<para>FNV1_64 item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-fnv1a-64">
<term><constant>Memcached::HASH_FNV1A_64</constant></term>
<listitem>
<para>FNV1_64A item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-fnv1-32">
<term><constant>Memcached::HASH_FNV1_32</constant></term>
<listitem>
<para>FNV1_32 item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-fnv1a-32">
<term><constant>Memcached::HASH_FNV1A_32</constant></term>
<listitem>
<para>FNV1_32A item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-hsieh">
<term><constant>Memcached::HASH_HSIEH</constant></term>
<listitem>
<para>Hsieh item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.hash-murmur">
<term><constant>Memcached::HASH_MURMUR</constant></term>
<listitem>
<para>Murmur item key hashing algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-distribution">
<term><constant>Memcached::OPT_DISTRIBUTION</constant></term>
<listitem>
<para>Specifies the method of distributing item keys to the servers.
Currently supported methods are modulo and consistent hashing. Consistent
hashing delivers better distribution and allows servers to be added to
the cluster with minimal cache losses.</para>
<para>Type: <literal>integer</literal>, default: <constant>Memcached::DISTRIBUTION_MODULA.</constant></para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.distribution-modula">
<term><constant>Memcached::DISTRIBUTION_MODULA</constant></term>
<listitem>
<para>Modulo-based key distribution algorithm.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.distribution-consistent">
<term><constant>Memcached::DISTRIBUTION_CONSISTENT</constant></term>
<listitem>
<para>Consistent hashing key distribution algorithm (based on libketama).</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-libketama-compatible">
<term><constant>Memcached::OPT_LIBKETAMA_COMPATIBLE</constant></term>
<listitem>
<para>Enables or disables compatibility with libketama-like behavior. When
enabled, the item key hashing algorithm is set to MD5 and distribution is
set to be weighted consistent hashing distribution. This is useful
because other libketama-based clients (Python, Ruby, etc.) with the same
server configuration will be able to access the keys transparently.
</para>
<note>
<para>
It is highly recommended to enable this option if you want to use
consistent hashing, and it may be enabled by default in future
releases.
</para>
</note>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-buffer-writes">
<term><constant>Memcached::OPT_BUFFER_WRITES</constant></term>
<listitem>
<para>Enables or disables buffered I/O. Enabling buffered I/O causes
storage commands to "buffer" instead of being sent. Any action that
retrieves data causes this buffer to be sent to the remote connection.
Quitting the connection or closing down the connection will also cause
the buffered data to be pushed to the remote connection.</para>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-binary-protocol">
<term><constant>Memcached::OPT_BINARY_PROTOCOL</constant></term>
<listitem>
<para>Enable the use of the binary protocol. Please note that you cannot
toggle this option on an open connection.</para>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-no-block">
<term><constant>Memcached::OPT_NO_BLOCK</constant></term>
<listitem>
<para>Enables or disables asynchronous I/O. This is the fastest transport
available for storage functions.</para>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-tcp-nodelay">
<term><constant>Memcached::OPT_TCP_NODELAY</constant></term>
<listitem>
<para>Enables or disables the no-delay feature for connecting sockets (may
be faster in some environments).</para>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-socket-send-size">
<term><constant>Memcached::OPT_SOCKET_SEND_SIZE</constant></term>
<listitem>
<para>The maximum socket send buffer in bytes.</para>
<para>Type: <literal>integer</literal>, default: varies by platform/kernel
configuration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-socket-recv-size">
<term><constant>Memcached::OPT_SOCKET_RECV_SIZE</constant></term>
<listitem>
<para>The maximum socket receive buffer in bytes.</para>
<para>Type: <literal>integer</literal>, default: varies by platform/kernel
configuration.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-connect-timeout">
<term><constant>Memcached::OPT_CONNECT_TIMEOUT</constant></term>
<listitem>
<para>In non-blocking mode this set the value of the timeout during socket
connection, in milliseconds.</para>
<para>Type: <literal>integer</literal>, default: <literal>1000</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-retry-timeout">
<term><constant>Memcached::OPT_RETRY_TIMEOUT</constant></term>
<listitem>
<para>The amount of time, in seconds, to wait until retrying a failed
connection attempt.</para>
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-send-timeout">
<term><constant>Memcached::OPT_SEND_TIMEOUT</constant></term>
<listitem>
<para>Socket sending timeout, in microseconds. In cases where you cannot
use non-blocking I/O this will allow you to still have timeouts on the
sending of data.</para>
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-recv-timeout">
<term><constant>Memcached::OPT_RECV_TIMEOUT</constant></term>
<listitem>
<para>Socket reading timeout, in microseconds. In cases where you cannot
use non-blocking I/O this will allow you to still have timeouts on the
reading of data.</para>
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-poll-timeout">
<term><constant>Memcached::OPT_POLL_TIMEOUT</constant></term>
<listitem>
<para>Timeout for connection polling, in milliseconds.</para>
<para>Type: <literal>integer</literal>, default: <literal>1000</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-cache-lookups">
<term><constant>Memcached::OPT_CACHE_LOOKUPS</constant></term>
<listitem>
<para>Enables or disables caching of DNS lookups.</para>
<para>Type: <literal>boolean</literal>, default: &false;.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.opt-server-failure-limit">
<term><constant>Memcached::OPT_SERVER_FAILURE_LIMIT</constant></term>
<listitem>
<para>Specifies the failure limit for server connection attempts. The
server will be removed after this many continuous connection
failures.</para>
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.have-igbinary">
<term><constant>Memcached::HAVE_IGBINARY</constant></term>
<listitem>
<para>Indicates whether igbinary serializer support is available.</para>
<para>Type: <literal>boolean</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.have-json">
<term><constant>Memcached::HAVE_JSON</constant></term>
<listitem>
<para>Indicates whether JSON serializer support is available.</para>
<para>Type: <literal>boolean</literal>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.get-preserve-order">
<term><constant>Memcached::GET_PRESERVE_ORDER</constant></term>
<listitem>
<para>A flag for <function>Memcached::getMulti</function> and
<function>Memcached::getMultiByKey</function> to ensure that the keys are
returned in the same order as they were requested in. Non-existing keys
get a default value of NULL.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-success">
<term><constant>Memcached::RES_SUCCESS</constant></term>
<listitem>
<para>The operation was successful.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-failure">
<term><constant>Memcached::RES_FAILURE</constant></term>
<listitem>
<para>The operation failed in some fashion.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-host-lookup-failure">
<term><constant>Memcached::RES_HOST_LOOKUP_FAILURE</constant></term>
<listitem>
<para>DNS lookup failed.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-unknown-read-failure">
<term><constant>Memcached::RES_UNKNOWN_READ_FAILURE</constant></term>
<listitem>
<para>Failed to read network data.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-protocol-error">
<term><constant>Memcached::RES_PROTOCOL_ERROR</constant></term>
<listitem>
<para>Bad command in memcached protocol.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-client-error">
<term><constant>Memcached::RES_CLIENT_ERROR</constant></term>
<listitem>
<para>Error on the client side.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-server-error">
<term><constant>Memcached::RES_SERVER_ERROR</constant></term>
<listitem>
<para>Error on the server side.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-write-failure">
<term><constant>Memcached::RES_WRITE_FAILURE</constant></term>
<listitem>
<para>Failed to write network data.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-data-exists">
<term><constant>Memcached::RES_DATA_EXISTS</constant></term>
<listitem>
<para>Failed to do compare-and-swap: item you are trying to store has been
modified since you last fetched it.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-notstored">
<term><constant>Memcached::RES_NOTSTORED</constant></term>
<listitem>
<para>Item was not stored: but not because of an error. This normally
means that either the condition for an "add" or a "replace" command
wasn't met, or that the item is in a delete queue.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-notfound">
<term><constant>Memcached::RES_NOTFOUND</constant></term>
<listitem>
<para>Item with this key was not found (with "get" operation or "cas"
operations).</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-partial-read">
<term><constant>Memcached::RES_PARTIAL_READ</constant></term>
<listitem>
<para>Partial network data read error.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-some-errors">
<term><constant>Memcached::RES_SOME_ERRORS</constant></term>
<listitem>
<para>Some errors occurred during multi-get.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-no-servers">
<term><constant>Memcached::RES_NO_SERVERS</constant></term>
<listitem>
<para>Server list is empty.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-end">
<term><constant>Memcached::RES_END</constant></term>
<listitem>
<para>End of result set.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-errno">
<term><constant>Memcached::RES_ERRNO</constant></term>
<listitem>
<para>System error.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-buffered">
<term><constant>Memcached::RES_BUFFERED</constant></term>
<listitem>
<para>The operation was buffered.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-timeout">
<term><constant>Memcached::RES_TIMEOUT</constant></term>
<listitem>
<para>The operation timed out.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-bad-key-provided">
<term><constant>Memcached::RES_BAD_KEY_PROVIDED</constant></term>
<listitem>
<para>Bad key.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-connection-socket-create-failure">
<term><constant>Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE</constant></term>
<listitem>
<para>Failed to create network socket.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="memcached.constants.res-payload-failure">
<term><constant>Memcached::RES_PAYLOAD_FAILURE</constant></term>
<listitem>
<para>Payload failure: could not compress/decompress or serialize/unserialize the value.</para>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- 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
-->