<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Runtime Configuration</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.resources.html">Resource Types</a></div>
<div class="up"><a href="memcached.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcached.configuration" class="section">
<h2 class="title">Runtime Configuration</h2>
<p class="simpara">
The behaviour of these functions is affected by settings in <var class="filename">php.ini</var>.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Memcached Configure Options</strong></caption>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Changeable</th>
<th>Changelog</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-locking" class="link">memcached.sess_locking</a></td>
<td>1</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-consistent-hash" class="link">memcached.sess_consistent_hash</a></td>
<td>0</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-binary" class="link">memcached.sess_binary</a></td>
<td>0</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-lock-wait" class="link">memcached.sess_lock_wait</a></td>
<td>150000</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-prefix" class="link">memcached.sess_prefix</a></td>
<td>memc.sess.key.</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-number-of-replicas" class="link">memcached.sess_number_of_replicas</a></td>
<td>0</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-randomize-replica-read" class="link">memcached.sess_randomize_replica_read</a></td>
<td>0</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.sess-remove-failed" class="link">memcached.sess_remove_failed</a></td>
<td>0</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.compression-type" class="link">memcached.compression_type</a></td>
<td>fastlz</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.compression-factor" class="link">memcached.compression_factor</a></td>
<td>1.3</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.compression-threshold" class="link">memcached.compression_threshold</a></td>
<td>2000</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.serializer" class="link">memcached.serializer</a></td>
<td>php</td>
<td>PHP_INI_ALL</td>
<td></td>
</tr>
<tr>
<td><a href="memcached.configuration.html#ini.memcached.use-sasl" class="link">memcached.use_sasl</a></td>
<td>0</td>
<td>PHP_INI_SYSTEM</td>
<td></td>
</tr>
</tbody>
</table>
</p>
<p class="para">Here's a short explanation of
the configuration directives.</p>
<p class="para">
<dl>
<dt id="ini.memcached.sess-locking">
<span class="term">
<em><code class="parameter">memcached.sess_locking</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Use session locking. Valid values: On, Off, the default is On.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-consistent-hash">
<span class="term">
<em><code class="parameter">memcached.sess_consistent_hash</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Memcached session consistent hash mode. If set to On, consistent
hashing is used for session handling. When consistent hashing is used,
one can add or remove cache node(s) without messing up too much with
existing keys. The default is Off.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-binary">
<span class="term">
<em><code class="parameter">memcached.sess_binary</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Use memcached session binary mode. Libmemcached replicas only work if
binary mode is enabled. The default is Off.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-lock-wait">
<span class="term">
<em><code class="parameter">memcached.sess_lock_wait</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Session spin lock retry wait time in microseconds. Be carefull when
setting this value. Valid values are integers, where 0 is interpreted
as the default value. Negative values result in a reduces locking to a
try lock. The default is 150000.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-prefix">
<span class="term">
<em><code class="parameter">memcached.sess_prefix</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Memcached session key prefix. Valid values are strings less than 219
bytes long. The default value is "memc.sess.key."
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-number-of-replicas">
<span class="term">
<em><code class="parameter">memcached.sess_number_of_replicas</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
The memcached session number of replicas.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-randomize-replica-read">
<span class="term">
<em><code class="parameter">memcached.sess_randomize_replica_read</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Memcached session replica read randomize.
</p>
</dd>
</dt>
<dt id="ini.memcached.sess-remove-failed">
<span class="term">
<em><code class="parameter">memcached.sess_remove_failed</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Allow failed memcached server to automatically be removed.
</p>
</dd>
</dt>
<dt id="ini.memcached.compression-type">
<span class="term">
<em><code class="parameter">memcached.compression_type</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Set the compression type, valid values are: fastlz, zlib. The default
is fastlz.
</p>
</dd>
</dt>
<dt id="ini.memcached.compression-factor">
<span class="term">
<em><code class="parameter">memcached.compression_factor</code></em>
<span class="type"><a href="language.types.float.html" class="type float">float</a></span>
</span>
<dd>
<p class="para">
Compression factor. Store compressed value only if the compression
factor (saving) exceeds the set limit. Store compressed if:
<em>plain_len > comp_len * factor</em>. The default value
is 1.3 (23% space saving).
</p>
</dd>
</dt>
<dt id="ini.memcached.compression-threshold">
<span class="term">
<em><code class="parameter">memcached.compression_threshold</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
The compression threshold. Do not compress serialized values below this
threshold. The default is 2000 bytes.
</p>
</dd>
</dt>
<dt id="ini.memcached.serializer">
<span class="term">
<em><code class="parameter">memcached.serializer</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
Set the default serializer for new memcached objects. Valid values
are: php, igbinary, json, json_array.
</p>
<dl>
<dt>
<span class="term">json</span>
<dd>
<p class="para">
Standard php JSON encoding. This serializer is fast and compact but
only works on UTF-8 encoded data and does not fully implement
serializing. See the JSON extension.
</p>
</dd>
</dt>
<dt>
<span class="term">json_array</span>
<dd>
<p class="para">
As json, but decodes into arrays.
</p>
</dd>
</dt>
<dt>
<span class="term">php</span>
<dd>
<p class="para">
The standard PHP serializer.
</p>
</dd>
</dt>
<dt>
<span class="term">igbinary</span>
<dd>
<p class="para">
A binary serializer
</p>
</dd>
</dt>
</dl>
<p class="para">
The default is igbinary if available and php otherwise.
</p>
</dd>
</dt>
<dt id="ini.memcached.use-sasl">
<span class="term">
<em><code class="parameter">memcached.use_sasl</code></em>
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
</span>
<dd>
<p class="para">
Use SASL authentication for connections. Valid values: On, Off. The
default is Off.
</p>
</dd>
</dt>
</dl>
</p>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.resources.html">Resource Types</a></div>
<div class="up"><a href="memcached.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
