1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.fam-next-event" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fam_next_event</refname>
<refpurpose>Get next pending FAM event</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fam_next_event</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
Returns the next pending FAM event.
</para>
<para>
The function will block until an event is available which can be checked
for using <function>fam_pending</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fam</parameter></term>
<listitem>
<para>
A resource representing a connection to the FAM service returned by
<function>fam_open</function>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that contains a FAM event code in the
'<literal>code</literal>' element, the path of the file this event applies
to in the '<literal>filename</literal>' element and optionally a hostname
in the '<literal>hostname</literal>' element.
</para>
<para>
The possible event codes are described in detail in the
<link linkend="fam.constants">constants part</link> of this section.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fam_pending</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
