<!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>Constructs the EvEmbed object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.evembed.html">EvEmbed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evembed.createstopped.html">EvEmbed::createStopped</a></div>
<div class="up"><a href="class.evembed.html">EvEmbed</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="evembed.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">EvEmbed::__construct</h1>
<p class="verinfo">(PECL ev >= 0.2.0)</p><p class="refpurpose"><span class="refname">EvEmbed::__construct</span> — <span class="dc-title">Constructs the EvEmbed object</span></p>
</div>
<div class="refsect1 description" id="refsect1-evembed.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="methodname"><strong>EvEmbed::__construct</strong></span>
( <span class="methodparam">
<span class="type">object</span>
<code class="parameter">$other</code>
</span>
[, <span class="methodparam">
<span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span>
<code class="parameter">$callback</code>
</span>
[, <span class="methodparam">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<code class="parameter">$data</code>
</span>
[, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$priority</code>
</span>
]]] )</div>
<p class="para rdfs-comment">
This is a rather advanced watcher type that lets to embed one event loop
into another(currently only IO events are supported in the embedded loop,
other types of watchers might be handled in a delayed or incorrect fashion
and must not be used).
</p>
<p class="para">
See
<a href="http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_" class="link external">» the
libev documentation</a>
for details.
</p>
<p class="para">
This watcher is most useful on
<em class="emphasis">BSD</em>
systems without working
<em>kqueue</em>
to still be able to handle a large number of sockets. See example below.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-evembed.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">other</code></em>
</span>
<dd>
<p class="para">
Instance of
<a href="class.evloop.html" class="classname">EvLoop</a>
. The loop to embed, this loop must be embeddable(see
<span class="methodname"><a href="ev.embeddablebackends.html" class="methodname">Ev::embeddableBackends()</a></span>
).
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">callback</code></em>
</span>
<dd>
<p class="para">
See
<a href="ev.watcher-callbacks.html" class="link">Watcher callbacks</a>
.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">data</code></em>
</span>
<dd>
<p class="para">
Custom data associated with the watcher.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">priority</code></em>
</span>
<dd>
<p class="para">
<a href="class.ev.html#ev.constants.watcher-pri" class="link">Watcher priority</a>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-evembed.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns EvEmbed object on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-evembed.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3626">
<p><strong>Example #1 Embedding loop created with kqueue backend into the default loop</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/*<br /> * Check if kqueue is available but not recommended and create a kqueue backend<br /> * for use with sockets (which usually work with any kqueue implementation).<br /> * Store the kqueue/socket-only event loop in loop_socket. (One might optionally<br /> * use EVFLAG_NOENV, too)<br /> *<br /> * Example borrowed from<br /> * http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#Examples_CONTENT-9<br /> */<br /></span><span style="color: #0000BB">$loop </span><span style="color: #007700">= </span><span style="color: #0000BB">EvLoop</span><span style="color: #007700">::</span><span style="color: #0000BB">defaultLoop</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$socket_loop </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$embed </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">Ev</span><span style="color: #007700">::</span><span style="color: #0000BB">supportedBackends</span><span style="color: #007700">() & ~</span><span style="color: #0000BB">Ev</span><span style="color: #007700">::</span><span style="color: #0000BB">recommendedBackends</span><span style="color: #007700">() & </span><span style="color: #0000BB">Ev</span><span style="color: #007700">::</span><span style="color: #0000BB">BACKEND_KQUEUE</span><span style="color: #007700">) {<br /> if ((</span><span style="color: #0000BB">$socket_loop </span><span style="color: #007700">= new </span><span style="color: #0000BB">EvLoop</span><span style="color: #007700">(</span><span style="color: #0000BB">Ev</span><span style="color: #007700">::</span><span style="color: #0000BB">BACKEND_KQUEUE</span><span style="color: #007700">))) {<br /> </span><span style="color: #0000BB">$embed </span><span style="color: #007700">= new </span><span style="color: #0000BB">EvEmbed</span><span style="color: #007700">(</span><span style="color: #0000BB">$loop</span><span style="color: #007700">);<br /> }<br />}<br /><br />if (!</span><span style="color: #0000BB">$socket_loop</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$socket_loop </span><span style="color: #007700">= </span><span style="color: #0000BB">$loop</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Now use $socket_loop for all sockets, and $loop for anything else<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-evembed.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="ev.embeddablebackends.html" class="methodname" rel="rdfs-seeAlso">Ev::embeddableBackends()</a> - Returns the set of backends that are embeddable in other event loops.</span>
</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.evembed.html">EvEmbed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evembed.createstopped.html">EvEmbed::createStopped</a></div>
<div class="up"><a href="class.evembed.html">EvEmbed</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
