mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 13:57:03 +08:00
137 lines
3.8 KiB
HTML
137 lines
3.8 KiB
HTML
<!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>Prepare a timer event</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.event-timer-set" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">event_timer_set</h1>
|
||
<p class="verinfo">(PECL libevent >= 0.0.2)</p><p class="refpurpose"><span class="refname">event_timer_set</span> — <span class="dc-title">Prepare a timer event</span></p>
|
||
|
||
</div>
|
||
|
||
<div class="refsect1 description" id="refsect1-function.event-timer-set-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>event_timer_set</strong></span>
|
||
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$event</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">$arg</code></span>
|
||
] ) : <span class="type">bool</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
Prepares the timer event to be used in <span class="function"><a href="event.add.html" class="function">event_add()</a></span>. The
|
||
event is prepared to call the function specified by the
|
||
<code class="parameter">callback</code> when the event timeout elapses.
|
||
</p>
|
||
<p class="para">
|
||
After initializing the event, use <span class="function"><a href="event_base_set.html" class="function">event_base_set()</a></span> to
|
||
associate the event with its event base.
|
||
</p>
|
||
<p class="para">
|
||
In case of matching event, these three arguments are passed to the
|
||
<code class="parameter">callback</code> function:
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">fd</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
Signal number or resource indicating the stream.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">events</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
A flag indicating the event. This will always be
|
||
<strong><code>EV_TIMEOUT</code></strong> for timer events.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">arg</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
Optional parameter, previously passed to
|
||
<span class="function"><strong>event_timer_set()</strong></span> as <code class="parameter">arg</code>.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.event-timer-set-parameters">
|
||
<h3 class="title">参数</h3>
|
||
<p class="para">
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">event</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
Valid event resource.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">callback</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
Callback function to be called when the matching event occurs.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">arg</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
Optional callback parameter.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.event-timer-set-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||
</p>
|
||
</div>
|
||
|
||
|
||
</div></div></div></body></html> |