<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ev.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'ev.periodic-modes.php',
    1 => 'Periodic ウォッチャーの操作モード',
    2 => 'Periodic ウォッチャーの操作モード',
  ),
  'up' => 
  array (
    0 => 'book.ev.php',
    1 => 'Ev',
  ),
  'prev' => 
  array (
    0 => 'ev.watcher-callbacks.php',
    1 => 'ウォッチャーのコールバック',
  ),
  'next' => 
  array (
    0 => 'class.ev.php',
    1 => 'Ev',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ev/periodic-modes.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="ev.periodic-modes" class="chapter">
 <h1 class="title">Periodic ウォッチャーの操作モード</h1>

 <p class="simpara">
  <span class="classname"><a href="class.evperiodic.php" class="classname">EvPeriodic</a></span>
  ウォッチャーは、パラメータ
  <code class="parameter">offset</code>、<code class="parameter">interval</code>
  および <code class="parameter">reschedule_cb</code>
  の設定によってさまざまなモードで動作します。
 </p>
 <ol type="1">
  <li class="listitem">
   <span class="simpara">
    <em>絶対時刻のタイマー</em>。
    このモードでは、<code class="parameter">interval</code> = <code class="literal">0</code>
    そして <code class="parameter">reschedule_cb</code> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> となります。
    このときは、単純に <code class="parameter">offset</code> で指定した時刻に実行してその後は繰り返しません。
    時刻の飛びがあっても調整はしません。つまり、
    <em>January 1st 2014</em> に実行するように設定した場合は、
    システム時刻がこの時刻に達するかこの時刻を過ぎたときに実行されます。
   </span>
  </li>
  <li class="listitem">
   <span class="simpara">
    <em>繰り返しタイマー</em>。
    このモードでは、<code class="parameter">interval</code> &gt; <code class="literal">0</code>
    そして <code class="parameter">reschedule_cb</code> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>
    となります。ウォッチャーは常に、
    <code class="parameter">offset</code> + <strong><code>N</code></strong> * <code class="parameter">interval</code>
    (<strong><code>N</code></strong> は何らかの整数) 経過後にタイムアウトするようにスケジュールされ、
    その後繰り返します。時刻の飛びは気にしません。
   </span>
   <p class="para">
    これを使うと、システムの時刻に流されないタイマーを作れます。
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$hourly </span><span style="color: #007700">= </span><span style="color: #0000BB">EvPeriodic</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">3600</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">, function () {<br />  echo </span><span style="color: #DD0000">"once per hour\n"</span><span style="color: #007700">;<br />});<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    これは、必ずしも <code class="literal">3600</code> 秒おきにイベントが発生することを意味するものではありません。
    システムの時刻が一時間経過するごとにコールバックが呼ばれるというものです。
   </p>
   <span class="simpara">
    <span class="classname"><a href="class.evperiodic.php" class="classname">EvPeriodic</a></span> は、
    <var class="varname">time</var> = <code class="parameter">offset</code>
    (<code class="literal">mod</code> <code class="parameter">interval</code>)
    となる次の時刻にコールバックをこのモードで実行しようと試みます。
    時刻の飛びは気にしません。
   </span>
  </li>
  <li class="listitem">
   <span class="simpara">
    <em>手動再スケジュールモード</em>。
    このモードでは、<code class="parameter">reschedule_cb</code>
    が <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> になります。
   </span>
   <span class="simpara">
    <code class="parameter">interval</code> と <code class="parameter">offset</code>
    はどちらも無視します。毎回定期ウォッチャーがスケジュールされ、再スケジュールコールバック
    (<code class="parameter">reschedule_cb</code>) が呼び出されます。
    コールバックの最初の引数がウォッチャー、そして二番目の引数が現在時刻となります。
   </span>
   <span class="simpara">
    このコールバックは、自分自身あるいは他の定期ウォッチャーを停止したり破棄したり
    <em>してはいけません</em>。また、
    イベントループ関数やメソッドも
    <em>呼んではいけません</em>。
    ウォッチャーを止めるには、<code class="literal">1e30</code>
    を返した後で停止します。
    このタスクには、<span class="classname"><a href="class.evprepare.php" class="classname">EvPrepare</a></span> ウォッチャーが使えます。
   </span>
   <span class="simpara">
    コールバックは、次の実行時刻を返す必要があります。次の実行時刻は、
    コールバックに渡された時刻をベースにしたものです
    (つまり、二番目の引数で受け取った時刻と同じかそれよりも大きな値を返します)。
    コールバックが呼ばれるのは、通常はイベントが発生する直前ですが、それ以外の場合にも呼ばれる可能性があります。
   </span>
   <div class="example" id="example-1">
    <p><strong>例1 再スケジュールコールバックの利用</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// 10.5 秒おきに繰り返します<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">reschedule_cb </span><span style="color: #007700">(</span><span style="color: #0000BB">$watcher</span><span style="color: #007700">, </span><span style="color: #0000BB">$now</span><span style="color: #007700">) {<br />   return </span><span style="color: #0000BB">$now </span><span style="color: #007700">+ (</span><span style="color: #0000BB">10.5</span><span style="color: #007700">. - </span><span style="color: #0000BB">fmod</span><span style="color: #007700">(</span><span style="color: #0000BB">$now</span><span style="color: #007700">, </span><span style="color: #0000BB">10.5</span><span style="color: #007700">));<br />}<br /><br /></span><span style="color: #0000BB">$w </span><span style="color: #007700">= new </span><span style="color: #0000BB">EvPeriodic</span><span style="color: #007700">(</span><span style="color: #0000BB">0.</span><span style="color: #007700">, </span><span style="color: #0000BB">0.</span><span style="color: #007700">, </span><span style="color: #DD0000">"reschedule_cb"</span><span style="color: #007700">, function (</span><span style="color: #0000BB">$w</span><span style="color: #007700">, </span><span style="color: #0000BB">$revents</span><span style="color: #007700">) {<br />   echo </span><span style="color: #0000BB">time</span><span style="color: #007700">(), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />});<br /><br /></span><span style="color: #0000BB">Ev</span><span style="color: #007700">::</span><span style="color: #0000BB">run</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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