Document some constants.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275310 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski 2009-02-07 00:16:56 +00:00
parent f3d0135425
commit ad6a921c1c

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<appendix xml:id="memcached.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
@ -146,91 +146,121 @@
<varlistentry xml:id="memcached.constants.opt-buffer-writes">
<term><constant>Memcached::OPT_BUFFER_WRITES</constant></term>
<listitem>
<para>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>Description here...</para>
<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>