<!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>The EvEmbed class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="evchild.set.html">EvChild::set</a></div> <div class="next" style="text-align: right; float: right;"><a href="evembed.construct.html">EvEmbed::__construct</a></div> <div class="up"><a href="book.ev.html">Ev</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.evembed" class="reference"> <h1 class="title">The EvEmbed class</h1> <div class="partintro"><p class="verinfo">(PECL ev >= 0.2.0)</p> <div class="section" id="evembed.intro"> <h2 class="title">Introduction</h2> <p class="para"> Used to embed one event loop into another. </p> </div> <div class="section" id="evembed.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"> </div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">EvEmbed</strong> </span> <span class="ooclass"> <span class="modifier">extends</span> <a href="class.evwatcher.html" class="classname">EvWatcher</a> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <var class="varname"><a href="class.evembed.html#evembed.props.embed">$<var class="varname">embed</var></a></var> ;</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><a href="evembed.construct.html" class="methodname">__construct</a></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> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">void</span> <span class="methodname"><a href="evembed.createstopped.html" class="methodname">createStopped</a></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> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evembed.set.html" class="methodname">set</a></span> ( <span class="methodparam"> <span class="type">object</span> <code class="parameter">$other</code> </span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evembed.sweep.html" class="methodname">sweep</a></span> ( <span class="methodparam">void</span> )</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="evwatcher.clear.html" class="methodname">EvWatcher::clear</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">abstract</span> <span class="modifier">public</span> <span class="methodname"><a href="evwatcher.construct.html" class="methodname">EvWatcher::__construct</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evwatcher.feed.html" class="methodname">EvWatcher::feed</a></span> ( <span class="methodparam"> <span class="type">int</span> <code class="parameter">$revents</code> </span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">EvLoop</span> <span class="methodname"><a href="evwatcher.getloop.html" class="methodname">EvWatcher::getLoop</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evwatcher.invoke.html" class="methodname">EvWatcher::invoke</a></span> ( <span class="methodparam"> <span class="type">int</span> <code class="parameter">$revents</code> </span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="evwatcher.keepalive.html" class="methodname">EvWatcher::keepalive</a></span> ([ <span class="methodparam"> <span class="type">bool</span> <code class="parameter">$value</code> </span> ] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evwatcher.setcallback.html" class="methodname">EvWatcher::setCallback</a></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> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evwatcher.start.html" class="methodname">EvWatcher::start</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="evwatcher.stop.html" class="methodname">EvWatcher::stop</a></span> ( <span class="methodparam">void</span> )</div> }</div> </div> <div class="section" id="evembed.props"> <h2 class="title">Properties</h2> <dl> <dt id="evembed.props.is-active"> <span class="term"> <var class="varname"><var class="varname">is_active</var></var> </span> <dd> <p class="para"/> </dd> </dt> <dt id="evembed.props.data"> <span class="term"> <var class="varname"><var class="varname">data</var></var> </span> <dd> <p class="para"/> </dd> </dt> <dt id="evembed.props.is-pending"> <span class="term"> <var class="varname"><var class="varname">is_pending</var></var> </span> <dd> <p class="para"/> </dd> </dt> <dt id="evembed.props.priority"> <span class="term"> <var class="varname"><var class="varname">priority</var></var> </span> <dd> <p class="para"/> </dd> </dt> <dt id="evembed.props.embed"> <span class="term"> <var class="varname"><var class="varname">embed</var></var> </span> <dd> <p class="para"/> </dd> </dt> </dl> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="evembed.construct.html">EvEmbed::__construct</a> — Constructs the EvEmbed object</li><li><a href="evembed.createstopped.html">EvEmbed::createStopped</a> — Create stopped EvEmbed watcher object</li><li><a href="evembed.set.html">EvEmbed::set</a> — Configures the watcher</li><li><a href="evembed.sweep.html">EvEmbed::sweep</a> — Make a single, non-blocking sweep over the embedded loop.</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="evchild.set.html">EvChild::set</a></div> <div class="next" style="text-align: right; float: right;"><a href="evembed.construct.html">EvEmbed::__construct</a></div> <div class="up"><a href="book.ev.html">Ev</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>