Source of: /manual/en/function.memcache-connect.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.memcache.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.memcache-connect.php',
1 => 'Memcache::connect',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'function.memcache-close.php',
1 => 'Memcache::close',
),
'next' =>
array (
0 => 'function.memcache-debug.php',
1 => 'memcache_debug',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.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>
<a name="function.memcache-connect.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>Memcache::connect</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$host</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$port</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$timeout</tt></span>
]] )</div>
<p class="para rdfs-comment">
<b>Memcache::connect()</b> establishes a connection to the
memcached server.
The connection, which was opened using
<b>Memcache::connect()</b> will be automatically closed at the
end of script execution. Also you can close it with
<a href="function.memcache-close.php" class="function">Memcache::close()</a>.
Also you can use <b>memcache_connect()</b> function.
</p>
</div>
<a name="function.memcache-connect.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">host</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Point to the host where memcached is listening for connections. This parameter
may also specify other transports like <i>unix:///path/to/memcached.sock</i>
to use UNIX domain sockets, in this case <i><tt class="parameter">port</tt></i>
must also
be set to <i>0</i>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">port</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Point to the port where memcached is listening for connections. Set this
parameter to <i>0</i> when using UNIX domain sockets.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">timeout</tt></i>
</span>
</dt><dd class="listitem">
<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>
</dl>
<p>
</p>
</div>
<a name="function.memcache-connect.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.memcache-connect.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>Memcache::connect()</b> example</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
<a name="function.memcache-connect.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.memcache-pconnect.php" class="function" rel="rdfs-seeAlso">Memcache::pconnect()</a> - Open memcached server persistent connection</li>
<li class="member"><a href="function.memcache-close.php" class="function" rel="rdfs-seeAlso">Memcache::close()</a> - Close memcached server connection</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
