reference/memcached/constants.xml
65f1e1978c89ba3ba24d8eff0907dedfac5fd5bb
...
...
@@ -13,7 +13,7 @@
13
13
item values longer than a certain threshold (currently 100 bytes) will be
14
14
compressed during storage and decompressed during retrieval
15
15
transparently.</para>
16
-
<para>Type: <literal>boolean</literal>, default: &true;.</para>
16
+
<para>Type: &boolean;, default: &true;.</para>
17
17
</listitem>
18
18
</varlistentry>
19
19

...
...
@@ -28,7 +28,7 @@
28
28
<literal>--enable-memcached-igbinary</literal> option and the
29
29
<literal>igbinary</literal> extension is loaded.
30
30
</para>
31
-
<para>Type: <literal>integer</literal>, default: <constant>Memcached::SERIALIZER_PHP</constant>.</para>
31
+
<para>Type: &integer;, default: <constant>Memcached::SERIALIZER_PHP</constant>.</para>
32
32
</listitem>
33
33
</varlistentry>
34
34

...
...
@@ -51,7 +51,7 @@
51
51
<varlistentry xml:id="memcached.constants.serializer-json">
52
52
<term><constant>Memcached::SERIALIZER_JSON</constant></term>
53
53
<listitem>
54
-
<para>The JSON serializer. Requires PHP 5.2.10+.</para>
54
+
<para>The JSON serializer.</para>
55
55
</listitem>
56
56
</varlistentry>
57
57

...
...
@@ -63,7 +63,7 @@
63
63
longer than <literal>128</literal> characters and will reduce the
64
64
maximum available key size. The prefix is applied only to the item keys,
65
65
not to the server keys.</para>
66
-
<para>Type: <literal>string</literal>, default: <literal>""</literal>.</para>
66
+
<para>Type: &string;, default: <literal>""</literal>.</para>
67
67
</listitem>
68
68
</varlistentry>
69
69

...
...
@@ -74,7 +74,7 @@
74
74
values are supplied via <constant>Memcached::HASH_*</constant> constants.
75
75
Each hash algorithm has its advantages and its disadvantages. Go with the
76
76
default if you don't know or don't care.</para>
77
-
<para>Type: <literal>integer</literal>, default: <constant>Memcached::HASH_DEFAULT</constant></para>
77
+
<para>Type: &integer;, default: <constant>Memcached::HASH_DEFAULT</constant></para>
78
78
</listitem>
79
79
</varlistentry>
80
80

...
...
@@ -148,7 +148,7 @@
148
148
Currently supported methods are modulo and consistent hashing. Consistent
149
149
hashing delivers better distribution and allows servers to be added to
150
150
the cluster with minimal cache losses.</para>
151
-
<para>Type: <literal>integer</literal>, default: <constant>Memcached::DISTRIBUTION_MODULA.</constant></para>
151
+
<para>Type: &integer;, default: <constant>Memcached::DISTRIBUTION_MODULA.</constant></para>
152
152
</listitem>
153
153
</varlistentry>
154
154

...
...
@@ -182,7 +182,7 @@
182
182
releases.
183
183
</para>
184
184
</note>
185
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
185
+
<para>Type: &boolean;, default: &false;.</para>
186
186
</listitem>
187
187
</varlistentry>
188
188

...
...
@@ -194,7 +194,7 @@
194
194
retrieves data causes this buffer to be sent to the remote connection.
195
195
Quitting the connection or closing down the connection will also cause
196
196
the buffered data to be pushed to the remote connection.</para>
197
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
197
+
<para>Type: &boolean;, default: &false;.</para>
198
198
</listitem>
199
199
</varlistentry>
200
200

...
...
@@ -203,7 +203,7 @@
203
203
<listitem>
204
204
<para>Enable the use of the binary protocol. Please note that you cannot
205
205
toggle this option on an open connection.</para>
206
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
206
+
<para>Type: &boolean;, default: &false;.</para>
207
207
</listitem>
208
208
</varlistentry>
209
209

...
...
@@ -212,7 +212,20 @@
212
212
<listitem>
213
213
<para>Enables or disables asynchronous I/O. This is the fastest transport
214
214
available for storage functions.</para>
215
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
215
+
<para>Type: &boolean;, default: &false;.</para>
216
+
</listitem>
217
+
</varlistentry>
218
+

219
+
<varlistentry xml:id="memcached.constants.opt-noreply">
220
+
<term><constant>Memcached::OPT_NOREPLY</constant></term>
221
+
<listitem>
222
+
<para>
223
+
Enables or disables ignoring the result of storage commands
224
+
(set, add, replace, append, prepend, delete, increment, decrement, etc.).
225
+
Storage commands will be sent without spending time waiting for a reply
226
+
(there would be no reply).
227
+
Retrieval commands such as <function>Memcached::get</function> are unaffected by this setting.</para>
228
+
<para>Type: &boolean;, default: &false;.</para>
216
229
</listitem>
217
230
</varlistentry>
218
231

...
...
@@ -221,7 +234,7 @@
221
234
<listitem>
222
235
<para>Enables or disables the no-delay feature for connecting sockets (may
223
236
be faster in some environments).</para>
224
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
237
+
<para>Type: &boolean;, default: &false;.</para>
225
238
</listitem>
226
239
</varlistentry>
227
240

...
...
@@ -229,7 +242,7 @@
229
242
<term><constant>Memcached::OPT_SOCKET_SEND_SIZE</constant></term>
230
243
<listitem>
231
244
<para>The maximum socket send buffer in bytes.</para>
232
-
<para>Type: <literal>integer</literal>, default: varies by platform/kernel
245
+
<para>Type: &integer;, default: varies by platform/kernel
233
246
configuration.</para>
234
247
</listitem>
235
248
</varlistentry>
...
...
@@ -238,7 +251,7 @@
238
251
<term><constant>Memcached::OPT_SOCKET_RECV_SIZE</constant></term>
239
252
<listitem>
240
253
<para>The maximum socket receive buffer in bytes.</para>
241
-
<para>Type: <literal>integer</literal>, default: varies by platform/kernel
254
+
<para>Type: &integer;, default: varies by platform/kernel
242
255
configuration.</para>
243
256
</listitem>
244
257
</varlistentry>
...
...
@@ -248,7 +261,7 @@
248
261
<listitem>
249
262
<para>In non-blocking mode this set the value of the timeout during socket
250
263
connection, in milliseconds.</para>
251
-
<para>Type: <literal>integer</literal>, default: <literal>1000</literal>.</para>
264
+
<para>Type: &integer;, default: <literal>1000</literal>.</para>
252
265
</listitem>
253
266
</varlistentry>
254
267

...
...
@@ -257,7 +270,7 @@
257
270
<listitem>
258
271
<para>The amount of time, in seconds, to wait until retrying a failed
259
272
connection attempt.</para>
260
-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
273
+
<para>Type: &integer;, default: <literal>0</literal>.</para>
261
274
</listitem>
262
275
</varlistentry>
263
276

...
...
@@ -267,7 +280,7 @@
267
280
<para>Socket sending timeout, in microseconds. In cases where you cannot
268
281
use non-blocking I/O this will allow you to still have timeouts on the
269
282
sending of data.</para>
270
-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
283
+
<para>Type: &integer;, default: <literal>0</literal>.</para>
271
284
</listitem>
272
285
</varlistentry>
273
286

...
...
@@ -277,7 +290,7 @@
277
290
<para>Socket reading timeout, in microseconds. In cases where you cannot
278
291
use non-blocking I/O this will allow you to still have timeouts on the
279
292
reading of data.</para>
280
-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
293
+
<para>Type: &integer;, default: <literal>0</literal>.</para>
281
294
</listitem>
282
295
</varlistentry>
283
296

...
...
@@ -285,7 +298,7 @@
285
298
<term><constant>Memcached::OPT_POLL_TIMEOUT</constant></term>
286
299
<listitem>
287
300
<para>Timeout for connection polling, in milliseconds.</para>
288
-
<para>Type: <literal>integer</literal>, default: <literal>1000</literal>.</para>
301
+
<para>Type: &integer;, default: <literal>1000</literal>.</para>
289
302
</listitem>
290
303
</varlistentry>
291
304

...
...
@@ -293,7 +306,7 @@
293
306
<term><constant>Memcached::OPT_CACHE_LOOKUPS</constant></term>
294
307
<listitem>
295
308
<para>Enables or disables caching of DNS lookups.</para>
296
-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
309
+
<para>Type: &boolean;, default: &false;.</para>
297
310
</listitem>
298
311
</varlistentry>
299
312

...
...
@@ -303,7 +316,7 @@
303
316
<para>Specifies the failure limit for server connection attempts. The
304
317
server will be removed after this many continuous connection
305
318
failures.</para>
306
-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
319
+
<para>Type: &integer;, default: <literal>0</literal>.</para>
307
320
</listitem>
308
321
</varlistentry>
309
322

...
...
@@ -311,7 +324,7 @@
311
324
<term><constant>Memcached::HAVE_IGBINARY</constant></term>
312
325
<listitem>
313
326
<para>Indicates whether igbinary serializer support is available.</para>
314
-
<para>Type: <literal>boolean</literal>.</para>
327
+
<para>Type: &boolean;.</para>
315
328
</listitem>
316
329
</varlistentry>
317
330

...
...
@@ -319,7 +332,42 @@
319
332
<term><constant>Memcached::HAVE_JSON</constant></term>
320
333
<listitem>
321
334
<para>Indicates whether JSON serializer support is available.</para>
322
-
<para>Type: <literal>boolean</literal>.</para>
335
+
<para>Type: &boolean;.</para>
336
+
</listitem>
337
+
</varlistentry>
338
+

339
+
<varlistentry xml:id="memcached.constants.have-msgpack">
340
+
<term><constant>Memcached::HAVE_MSGPACK</constant></term>
341
+
<listitem>
342
+
<para>Indicates whether msgpack serializer support is available.</para>
343
+
<para>Type: &boolean;.</para>
344
+
<para>Available as of Memcached 3.0.0.</para>
345
+
</listitem>
346
+
</varlistentry>
347
+

348
+
<varlistentry xml:id="memcached.constants.have-session">
349
+
<term><constant>Memcached::HAVE_SESSION</constant></term>
350
+
<listitem>
351
+
<para>Type: &boolean;.</para>
352
+
<para>Available as of Memcached 3.0.0.</para>
353
+
</listitem>
354
+
</varlistentry>
355
+

356
+
<varlistentry xml:id="memcached.constants.have-sasl">
357
+
<term><constant>Memcached::HAVE_SASL</constant></term>
358
+
<listitem>
359
+
<para>Type: &boolean;.</para>
360
+
<para>Available as of Memcached 3.0.0.</para>
361
+
</listitem>
362
+
</varlistentry>
363
+

364
+
<varlistentry xml:id="memcached.constants.get-extended">
365
+
<term><constant>Memcached::GET_EXTENDED</constant></term>
366
+
<listitem>
367
+
<para>A flag for <function>Memcached::get</function>, <function>Memcached::getMulti</function> and
368
+
<function>Memcached::getMultiByKey</function> to ensure that the CAS token values
369
+
are returned as well.</para>
370
+
<para>Available as of Memcached 3.0.0.</para>
323
371
</listitem>
324
372
</varlistentry>
325
373

...
...
@@ -484,6 +532,55 @@
484
532
</listitem>
485
533
</varlistentry>
486
534

535
+
<varlistentry xml:id="memcached.constants.res-auth-problem">
536
+
<term><constant>Memcached::RES_AUTH_PROBLEM</constant></term>
537
+
<listitem>
538
+
<para>Available as of Memcached 3.0.0.</para>
539
+
</listitem>
540
+
</varlistentry>
541
+

542
+
<varlistentry xml:id="memcached.constants.res-auth-failure">
543
+
<term><constant>Memcached::RES_AUTH_FAILURE</constant></term>
544
+
<listitem>
545
+
<para>Available as of Memcached 3.0.0.</para>
546
+
</listitem>
547
+
</varlistentry>
548
+

549
+
<varlistentry xml:id="memcached.constants.res-auth-continue">
550
+
<term><constant>Memcached::RES_AUTH_CONTINUE</constant></term>
551
+
<listitem>
552
+
<para>Available as of Memcached 3.0.0.</para>
553
+
</listitem>
554
+
</varlistentry>
555
+

556
+
<varlistentry xml:id="memcached.constants.res-e2big">
557
+
<term><constant>Memcached::RES_E2BIG</constant></term>
558
+
<listitem>
559
+
<para>Available as of Memcached 3.0.0.</para>
560
+
</listitem>
561
+
</varlistentry>
562
+

563
+
<varlistentry xml:id="memcached.constants.res-key-too-big">
564
+
<term><constant>Memcached::RES_KEY_TOO_BIG</constant></term>
565
+
<listitem>
566
+
<para>Available as of Memcached 3.0.0.</para>
567
+
</listitem>
568
+
</varlistentry>
569
+

570
+
<varlistentry xml:id="memcached.constants.res-server-temporarily-disabled">
571
+
<term><constant>Memcached::RES_SERVER_TEMPORARILY_DISABLED</constant></term>
572
+
<listitem>
573
+
<para>Available as of Memcached 3.0.0.</para>
574
+
</listitem>
575
+
</varlistentry>
576
+

577
+
<varlistentry xml:id="memcached.constants.res-server-memory-allocation-failure">
578
+
<term><constant>Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE</constant></term>
579
+
<listitem>
580
+
<para>Available as of Memcached 3.0.0.</para>
581
+
</listitem>
582
+
</varlistentry>
583
+

487
584
</variablelist>
488
585
</appendix>
489
586

490
587