Skip to content

Commit d5a9cd5

Browse files
TysonAndremarcovtwout
authored andcommitted
Document Memcached::OPT_NOREPLY
This was added in 2009. A lot of other constants were also added. See http://docs.libmemcached.org/memcached_behavior.html Co-authored-by: Christoph M. Becker <[email protected]> Closes phpGH-584.
1 parent d45150a commit d5a9cd5

File tree

1 file changed

+37
-24
lines changed

1 file changed

+37
-24
lines changed

reference/memcached/constants.xml

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
item values longer than a certain threshold (currently 100 bytes) will be
1414
compressed during storage and decompressed during retrieval
1515
transparently.</para>
16-
<para>Type: <literal>boolean</literal>, default: &true;.</para>
16+
<para>Type: &boolean;, default: &true;.</para>
1717
</listitem>
1818
</varlistentry>
1919

@@ -28,7 +28,7 @@
2828
<literal>--enable-memcached-igbinary</literal> option and the
2929
<literal>igbinary</literal> extension is loaded.
3030
</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>
3232
</listitem>
3333
</varlistentry>
3434

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

@@ -74,7 +74,7 @@
7474
values are supplied via <constant>Memcached::HASH_*</constant> constants.
7575
Each hash algorithm has its advantages and its disadvantages. Go with the
7676
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>
7878
</listitem>
7979
</varlistentry>
8080

@@ -148,7 +148,7 @@
148148
Currently supported methods are modulo and consistent hashing. Consistent
149149
hashing delivers better distribution and allows servers to be added to
150150
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>
152152
</listitem>
153153
</varlistentry>
154154

@@ -182,7 +182,7 @@
182182
releases.
183183
</para>
184184
</note>
185-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
185+
<para>Type: &boolean;, default: &false;.</para>
186186
</listitem>
187187
</varlistentry>
188188

@@ -194,7 +194,7 @@
194194
retrieves data causes this buffer to be sent to the remote connection.
195195
Quitting the connection or closing down the connection will also cause
196196
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>
198198
</listitem>
199199
</varlistentry>
200200

@@ -203,7 +203,7 @@
203203
<listitem>
204204
<para>Enable the use of the binary protocol. Please note that you cannot
205205
toggle this option on an open connection.</para>
206-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
206+
<para>Type: &boolean;, default: &false;.</para>
207207
</listitem>
208208
</varlistentry>
209209

@@ -212,7 +212,20 @@
212212
<listitem>
213213
<para>Enables or disables asynchronous I/O. This is the fastest transport
214214
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>
216229
</listitem>
217230
</varlistentry>
218231

@@ -221,15 +234,15 @@
221234
<listitem>
222235
<para>Enables or disables the no-delay feature for connecting sockets (may
223236
be faster in some environments).</para>
224-
<para>Type: <literal>boolean</literal>, default: &false;.</para>
237+
<para>Type: &boolean;, default: &false;.</para>
225238
</listitem>
226239
</varlistentry>
227240

228241
<varlistentry xml:id="memcached.constants.opt-socket-send-size">
229242
<term><constant>Memcached::OPT_SOCKET_SEND_SIZE</constant></term>
230243
<listitem>
231244
<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
233246
configuration.</para>
234247
</listitem>
235248
</varlistentry>
@@ -238,7 +251,7 @@
238251
<term><constant>Memcached::OPT_SOCKET_RECV_SIZE</constant></term>
239252
<listitem>
240253
<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
242255
configuration.</para>
243256
</listitem>
244257
</varlistentry>
@@ -248,7 +261,7 @@
248261
<listitem>
249262
<para>In non-blocking mode this set the value of the timeout during socket
250263
connection, in milliseconds.</para>
251-
<para>Type: <literal>integer</literal>, default: <literal>1000</literal>.</para>
264+
<para>Type: &integer;, default: <literal>1000</literal>.</para>
252265
</listitem>
253266
</varlistentry>
254267

@@ -257,7 +270,7 @@
257270
<listitem>
258271
<para>The amount of time, in seconds, to wait until retrying a failed
259272
connection attempt.</para>
260-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
273+
<para>Type: &integer;, default: <literal>0</literal>.</para>
261274
</listitem>
262275
</varlistentry>
263276

@@ -267,7 +280,7 @@
267280
<para>Socket sending timeout, in microseconds. In cases where you cannot
268281
use non-blocking I/O this will allow you to still have timeouts on the
269282
sending of data.</para>
270-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
283+
<para>Type: &integer;, default: <literal>0</literal>.</para>
271284
</listitem>
272285
</varlistentry>
273286

@@ -277,23 +290,23 @@
277290
<para>Socket reading timeout, in microseconds. In cases where you cannot
278291
use non-blocking I/O this will allow you to still have timeouts on the
279292
reading of data.</para>
280-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
293+
<para>Type: &integer;, default: <literal>0</literal>.</para>
281294
</listitem>
282295
</varlistentry>
283296

284297
<varlistentry xml:id="memcached.constants.opt-poll-timeout">
285298
<term><constant>Memcached::OPT_POLL_TIMEOUT</constant></term>
286299
<listitem>
287300
<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>
289302
</listitem>
290303
</varlistentry>
291304

292305
<varlistentry xml:id="memcached.constants.opt-cache-lookups">
293306
<term><constant>Memcached::OPT_CACHE_LOOKUPS</constant></term>
294307
<listitem>
295308
<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>
297310
</listitem>
298311
</varlistentry>
299312

@@ -303,47 +316,47 @@
303316
<para>Specifies the failure limit for server connection attempts. The
304317
server will be removed after this many continuous connection
305318
failures.</para>
306-
<para>Type: <literal>integer</literal>, default: <literal>0</literal>.</para>
319+
<para>Type: &integer;, default: <literal>0</literal>.</para>
307320
</listitem>
308321
</varlistentry>
309322

310323
<varlistentry xml:id="memcached.constants.have-igbinary">
311324
<term><constant>Memcached::HAVE_IGBINARY</constant></term>
312325
<listitem>
313326
<para>Indicates whether igbinary serializer support is available.</para>
314-
<para>Type: <literal>boolean</literal>.</para>
327+
<para>Type: &boolean;.</para>
315328
</listitem>
316329
</varlistentry>
317330

318331
<varlistentry xml:id="memcached.constants.have-json">
319332
<term><constant>Memcached::HAVE_JSON</constant></term>
320333
<listitem>
321334
<para>Indicates whether JSON serializer support is available.</para>
322-
<para>Type: <literal>boolean</literal>.</para>
335+
<para>Type: &boolean;.</para>
323336
</listitem>
324337
</varlistentry>
325338

326339
<varlistentry xml:id="memcached.constants.have-msgpack">
327340
<term><constant>Memcached::HAVE_MSGPACK</constant></term>
328341
<listitem>
329342
<para>Indicates whether msgpack serializer support is available.</para>
330-
<para>Type: <literal>boolean</literal>.</para>
343+
<para>Type: &boolean;.</para>
331344
<para>Available as of Memcached 3.0.0.</para>
332345
</listitem>
333346
</varlistentry>
334347

335348
<varlistentry xml:id="memcached.constants.have-session">
336349
<term><constant>Memcached::HAVE_SESSION</constant></term>
337350
<listitem>
338-
<para>Type: <literal>boolean</literal>.</para>
351+
<para>Type: &boolean;.</para>
339352
<para>Available as of Memcached 3.0.0.</para>
340353
</listitem>
341354
</varlistentry>
342355

343356
<varlistentry xml:id="memcached.constants.have-sasl">
344357
<term><constant>Memcached::HAVE_SASL</constant></term>
345358
<listitem>
346-
<para>Type: <literal>boolean</literal>.</para>
359+
<para>Type: &boolean;.</para>
347360
<para>Available as of Memcached 3.0.0.</para>
348361
</listitem>
349362
</varlistentry>

0 commit comments

Comments
 (0)