<!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 EvSignal class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="evprepare.createstopped.html">EvPrepare::createStopped</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evsignal.construct.html">EvSignal::__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.evsignal" class="reference">
<h1 class="title">The EvSignal class</h1>
<div class="partintro"><p class="verinfo">(PECL ev >= 0.2.0)</p>
<div class="section" id="evsignal.intro">
<h2 class="title">Introduction</h2>
<p class="para">
<strong class="classname">EvSignal</strong>
watchers will trigger an event when the process receives a specific signal
one or more times. Even though signals are very asynchronous,
<em class="emphasis">libev</em>
will try its best to deliver signals synchronously, i.e. as part of the
normal event processing, like any other event.
</p>
<p class="para">
There is no limit for the number of watchers for the same signal, but only
within the same loop, i.e. one can watch for
<strong><code>SIGINT</code></strong>
in the default loop and for
<strong><code>SIGIO</code></strong>
in another loop, but it is not allowed to watch for
<strong><code>SIGINT</code></strong>
in both the default loop and another loop at the same time. At the moment,
<strong><code>SIGCHLD</code></strong>
is permanently tied to the default loop.
</p>
<p class="para">
If possible and supported,
<em class="emphasis">libev</em>
will install its handlers with
<em>SA_RESTART</em>
(or equivalent) behaviour enabled, so system calls should not be unduly
interrupted. In case of a problem with system calls getting interrupted by
signals, all the signals can be blocked in an
<a href="class.evcheck.html" class="classname">EvCheck</a>
watcher and unblocked in a
<a href="class.evprepare.html" class="classname">EvPrepare</a>
watcher.
</p>
</div>
<div class="section" id="evsignal.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass">
</div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">EvSignal</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.evsignal.html#evsignal.props.signum">$<var class="varname">signum</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.evwatcher.html#evwatcher.props.is-active">$<var class="varname">is_active</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.evwatcher.html#evwatcher.props.data">$<var class="varname">data</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.evwatcher.html#evwatcher.props.is-pending">$<var class="varname">is_pending</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.evwatcher.html#evwatcher.props.priority">$<var class="varname">priority</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="evsignal.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$signum</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 class="initializer"> = <strong><code>NULL</code></strong></span>
</span>
[, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$priority</code>
<span class="initializer"> = 0</span>
</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">EvSignal</span>
<span class="methodname"><a href="evsignal.createstopped.html" class="methodname">createStopped</a></span>
( <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$signum</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 class="initializer"> = <strong><code>NULL</code></strong></span>
</span>
[, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$priority</code>
<span class="initializer"> = 0</span>
</span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">void</span>
<span class="methodname"><a href="evsignal.set.html" class="methodname">set</a></span>
( <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$signum</code>
</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="evsignal.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="evsignal.props.signum">
<span class="term">
<var class="varname"><var class="varname">signum</var></var>
</span>
<dd>
<p class="para">
Signal number. See the constants exported by
<em class="emphasis">pcntl</em>
extension. See also
<em>signal(7)</em>
man page.
</p>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="evsignal.construct.html">EvSignal::__construct</a> — Constructs EvPeriodic watcher object</li><li><a href="evsignal.createstopped.html">EvSignal::createStopped</a> — Create stopped EvSignal watcher object</li><li><a href="evsignal.set.html">EvSignal::set</a> — Configures the watcher</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="evprepare.createstopped.html">EvPrepare::createStopped</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evsignal.construct.html">EvSignal::__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>
