<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.event.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'event.signal.php',
    1 => 'Event::signal',
    2 => 'Constructs signal event object',
  ),
  'up' => 
  array (
    0 => 'class.event.php',
    1 => 'Event',
  ),
  'prev' => 
  array (
    0 => 'event.settimer.php',
    1 => 'Event::setTimer',
  ),
  'next' => 
  array (
    0 => 'event.timer.php',
    1 => 'Event::timer',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/event/event/signal.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="event.signal" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Event::signal</h1>
  <p class="verinfo">(PECL event &gt;= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">Event::signal</span> &mdash; <span class="dc-title">Constructs signal event object</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-event.signal-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span>
   <span class="modifier">static</span>
   <span class="methodname"><strong>Event::signal</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="class.eventbase.php" class="type EventBase">EventBase</a></span> <code class="parameter">$base</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$signum</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$cb</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$arg</code>
   <span class="initializer"> = ?</span></span><br>): <span class="type"><a href="class.event.php" class="type Event">Event</a></span></div>

  <p class="para rdfs-comment">
   Constructs signal event object. This is a straightforward method to create
   a signal event. Note, the generic
   <span class="methodname"><a href="event.construct.php" class="methodname">Event::__construct()</a></span>
   method can contruct signal event objects too.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-event.signal-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <dl>
   
    <dt>
     <code class="parameter">base</code>
    </dt>
    <dd>
     <p class="para">
      The associated event base object.
     </p>
    </dd>
   
   
    <dt>
     <code class="parameter">signum</code>
    </dt>
    <dd>
     <p class="para">
      The signal number.
     </p>
    </dd>
   
   
    <dt>
     <code class="parameter">cb</code>
    </dt>
    <dd>
     <p class="para">
      The signal event callback. See
      <a href="event.callbacks.php" class="link">Event callbacks</a>.
     </p>
    </dd>
   
   
    <dt>
     <code class="parameter">arg</code>
    </dt>
    <dd>
     <p class="para">
      Custom data. If specified, it will be passed to the callback when event
      triggers.
     </p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-event.signal-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   Returns Event object on success. Otherwise <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-event.signal-seealso">
  <h3 class="title">Siehe auch</h3>
  <ul class="simplelist">
   <li>
    <a href="event.constructing.signal.events.php" class="link">Constructing signal events</a>
   </li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>