<!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>Open memcached server connection</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcache.close.html">Memcache::close</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcache.decrement.html">Memcache::decrement</a></div> <div class="up"><a href="class.memcache.html">Memcache</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="memcache.connect" class="refentry"> <div class="refnamediv"> <h1 class="refname">Memcache::connect</h1> <p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::connect</span> — <span class="dc-title">Open memcached server connection</span></p> </div> <div class="refsect1 description" id="refsect1-memcache.connect-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>Memcache::connect</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span> ]] )</div> <p class="para rdfs-comment"> <span class="function"><strong>Memcache::connect()</strong></span> establishes a connection to the memcached server. The connection, which was opened using <span class="function"><strong>Memcache::connect()</strong></span> will be automatically closed at the end of script execution. Also you can close it with <span class="function"><a href="memcache.close.html" class="function">Memcache::close()</a></span>. Also you can use <span class="function"><strong>memcache_connect()</strong></span> function. </p> </div> <div class="refsect1 parameters" id="refsect1-memcache.connect-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">host</code></em></span> <dd> <p class="para"> Point to the host where memcached is listening for connections. This parameter may also specify other transports like <em>unix:///path/to/memcached.sock</em> to use UNIX domain sockets, in this case <em><code class="parameter">port</code></em> must also be set to <em>0</em>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">port</code></em></span> <dd> <p class="para"> Point to the port where memcached is listening for connections. Set this parameter to <em>0</em> when using UNIX domain sockets. </p> <p class="para"> Please note: <em><code class="parameter">port</code></em> defaults to <a href="memcache.ini.html#ini.memcache.default-port" class="link">memcache.default_port</a> if not specified. For this reason it is wise to specify the port explicitly in this method call. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">timeout</code></em></span> <dd> <p class="para"> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 notes" id="refsect1-memcache.connect-notes"> <h3 class="title">Notes</h3> <div class="warning"><strong class="warning">Warning</strong> <p class="para"> When the <em><code class="parameter">port</code></em> is unspecified, this method defaults to the value set of the PHP ini directive <a href="memcache.ini.html#ini.memcache.default-port" class="link">memcache.default_port</a> If this value was changed elsewhere in your application it might lead to unexpected results: for this reason it is wise to always specify the port explicitly in this method call. </p> </div> </div> <div class="refsect1 returnvalues" id="refsect1-memcache.connect-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-memcache.connect-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4411"> <p><strong>Example #1 <span class="function"><strong>Memcache::connect()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /><br /></span><span style="color: #0000BB">$memcache_obj </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* OO API */<br /><br /></span><span style="color: #0000BB">$memcache </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcache</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$memcache</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-memcache.connect-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="memcache.pconnect.html" class="function" rel="rdfs-seeAlso">Memcache::pconnect()</a> - Open memcached server persistent connection</span></li> <li class="member"> <span class="function"><a href="memcache.close.html" class="function" rel="rdfs-seeAlso">Memcache::close()</a> - Close memcached server connection</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcache.close.html">Memcache::close</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcache.decrement.html">Memcache::decrement</a></div> <div class="up"><a href="class.memcache.html">Memcache</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>