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 GH-584.
php · Aug 17, 2021 · 65f1e19 · 65f1e19
1 parent a63794e
commit 65f1e19
Showing 1 changed file with 37 additions and 24 deletions.
diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml
@@ -13,7 +13,7 @@
  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>
+ <para>Type: &boolean;, default: &true;.</para>
  </listitem>
  </varlistentry>
 
@@ -28,7 +28,7 @@
  <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>
+ <para>Type: &integer;, default: <constant>Memcached::SERIALIZER_PHP</constant>.</para>
  </listitem>
  </varlistentry>
 
@@ -63,7 +63,7 @@
  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>
+ <para>Type: &string;, default: <literal>""</literal>.</para>
  </listitem>
  </varlistentry>
 
@@ -74,7 +74,7 @@
  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>
+ <para>Type: &integer;, default: <constant>Memcached::HASH_DEFAULT</constant></para>
  </listitem>
  </varlistentry>
 
@@ -148,7 +148,7 @@
  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>
+ <para>Type: &integer;, default: <constant>Memcached::DISTRIBUTION_MODULA.</constant></para>
  </listitem>
  </varlistentry>
 
@@ -182,7 +182,7 @@
  releases.
  </para>
  </note>
- <para>Type: <literal>boolean</literal>, default: &false;.</para>
+ <para>Type: &boolean;, default: &false;.</para>
  </listitem>
  </varlistentry>
 
@@ -194,7 +194,7 @@
  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>
+ <para>Type: &boolean;, default: &false;.</para>
  </listitem>
  </varlistentry>
 
@@ -203,7 +203,7 @@
  <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>
+ <para>Type: &boolean;, default: &false;.</para>
  </listitem>
  </varlistentry>
 
@@ -212,7 +212,20 @@
  <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>
+ <para>Type: &boolean;, default: &false;.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="memcached.constants.opt-noreply">
+ <term><constant>Memcached::OPT_NOREPLY</constant></term>
+ <listitem>
+ <para>
+ Enables or disables ignoring the result of storage commands 
+ (set, add, replace, append, prepend, delete, increment, decrement, etc.). 
+ Storage commands will be sent without spending time waiting for a reply 
+ (there would be no reply).
+ Retrieval commands such as <function>Memcached::get</function> are unaffected by this setting.</para>
+ <para>Type: &boolean;, default: &false;.</para>
  </listitem>
  </varlistentry>
 
@@ -221,15 +234,15 @@
  <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>
+ <para>Type: &boolean;, 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
+ <para>Type: &integer;, default: varies by platform/kernel
  configuration.</para>
  </listitem>
  </varlistentry>
@@ -238,7 +251,7 @@
  <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
+ <para>Type: &integer;, default: varies by platform/kernel
  configuration.</para>
  </listitem>
  </varlistentry>
@@ -248,7 +261,7 @@
  <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>
+ <para>Type: &integer;, default: <literal>1000</literal>.</para>
  </listitem>
  </varlistentry>
 
@@ -257,7 +270,7 @@
  <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>
+ <para>Type: &integer;, default: <literal>0</literal>.</para>
  </listitem>
  </varlistentry>
 
@@ -267,7 +280,7 @@
  <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>
+ <para>Type: &integer;, default: <literal>0</literal>.</para>
  </listitem>
  </varlistentry>
 
@@ -277,23 +290,23 @@
  <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>
+ <para>Type: &integer;, 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>
+ <para>Type: &integer;, 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>
+ <para>Type: &boolean;, default: &false;.</para>
  </listitem>
  </varlistentry>
 
@@ -303,47 +316,47 @@
  <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>
+ <para>Type: &integer;, 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>
+ <para>Type: &boolean;.</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>
+ <para>Type: &boolean;.</para>
  </listitem>
  </varlistentry>
 
  <varlistentry xml:id="memcached.constants.have-msgpack">
  <term><constant>Memcached::HAVE_MSGPACK</constant></term>
  <listitem>
  <para>Indicates whether msgpack serializer support is available.</para>
- <para>Type: <literal>boolean</literal>.</para>
+ <para>Type: &boolean;.</para>
  <para>Available as of Memcached 3.0.0.</para>
  </listitem>
  </varlistentry>
 
  <varlistentry xml:id="memcached.constants.have-session">
  <term><constant>Memcached::HAVE_SESSION</constant></term>
  <listitem>
- <para>Type: <literal>boolean</literal>.</para>
+ <para>Type: &boolean;.</para>
  <para>Available as of Memcached 3.0.0.</para>
  </listitem>
  </varlistentry>
 
  <varlistentry xml:id="memcached.constants.have-sasl">
  <term><constant>Memcached::HAVE_SASL</constant></term>
  <listitem>
- <para>Type: <literal>boolean</literal>.</para>
+ <para>Type: &boolean;.</para>
  <para>Available as of Memcached 3.0.0.</para>
  </listitem>
  </varlistentry>