Our source is open
The syntax highlighted source is automatically generated by PHP from
the plaintext script.
If you're interested in what's behind the several functions we
used, you can always take a look at the source of the following files:
Of course, if you want to see the source
of this page, we have it available.
You can also browse the SVN repository for this website on
svn.php.net.
Source of: /manual/en/function.inotify-read.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.inotify.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.inotify-read.php',
1 => 'inotify_read',
),
'up' =>
array (
0 => 'ref.inotify.php',
1 => 'Inotify Functions',
),
'prev' =>
array (
0 => 'function.inotify-queue-len.php',
1 => 'inotify_queue_len',
),
'next' =>
array (
0 => 'function.inotify-rm-watch.php',
1 => 'inotify_rm_watch',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.inotify-read" class="refentry">
<div class="refnamediv">
<h1 class="refname">inotify_read</h1>
<p class="verinfo">(PECL inotify >= 0.1.2)</p><p class="refpurpose"><span class="refname">inotify_read</span> — <span class="dc-title">Read events from an inotify instance</span></p>
</div>
<a name="function.inotify-read.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>inotify_read</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$inotify_instance</tt></span>
)</div>
<p class="para rdfs-comment">
Read inotify events from an inotify instance.
</p>
</div>
<a name="function.inotify-read.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">inotify_instance</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Resource returned by
<a href="function.inotify-init.php" class="function">inotify_init()</a>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.inotify-read.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An array of inotify events or <b><tt class="constant">FALSE</tt></b> if no events was pending and
<i><tt class="parameter">inotify_instance</tt></i>
is non-blocking. Each event is an array with the following keys:
</p><ul class="simplelist">
<li class="member">wd is a watch descriptor returned by
<a href="function.inotify-add-watch.php" class="function">inotify_add_watch()</a></li>
<li class="member">mask is a bit mask of <a href="inotify.constants.php" class="link">events</a></li>
<li class="member">cookie is a unique id to connect related events (e.g. <b><tt class="constant">IN_MOVE_FROM</tt></b>
and <b><tt class="constant">IN_MOVE_TO</tt></b>)</li>
<li class="member">name is the name of a file (e.g. if a file was modified in a
watched directory)</li>
</ul><p>
</p>
</div>
<a name="function.inotify-read.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.inotify-init.php" class="function" rel="rdfs-seeAlso">inotify_init()</a> - Initialize an inotify instance</li>
<li class="member"><a href="function.stream-select.php" class="function" rel="rdfs-seeAlso">stream_select()</a> - Runs the equivalent of the select() system call on the given
arrays of streams with a timeout specified by tv_sec and tv_usec</li>
<li class="member"><a href="function.stream-set-blocking.php" class="function" rel="rdfs-seeAlso">stream_set_blocking()</a> - Set blocking/non-blocking mode on a stream</li>
<li class="member"><a href="function.inotify-queue-len.php" class="function" rel="rdfs-seeAlso">inotify_queue_len()</a> - Return a number upper than zero if there are pending events</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
