Linux-Inotify2/Inotify2.pm

=head1 NAME

Linux::Inotify2 - scalable directory/file change notification

=head1 SYNOPSIS

=head2 Callback interface

 use Linux::Inotify2;

 # create a new object
 my $inotify = new Linux::Inotify2
    or die "Unable to create new inotify object: $!";
 
 # for Event:
 Event->io (fd =>$inotify->fileno, poll => 'r', cb => sub { $inotify->poll });
 # for Glib:
 add_watch Glib::IO $inotify->fileno, in => sub { $inotify->poll };
 # manually:
 1 while $inotify->poll;

 # add watchers
 $inotify->watch ("/etc/passwd", IN_ACCESS, sub {
    my $e = shift;
    my $name = $e->fullname;
    print "$name was accessed\n" if $e->IN_ACCESS;
    print "$name is no longer mounted\n" if $e->IN_UNMOUNT;
    print "$name is gone\n" if $e->IN_IGNORED;
    print "events for $name have been lost\n" if $e->IN_Q_OVERFLOW;
 
    # cancel this watcher: remove no further events
    $e->w->cancel;
 });

=head2 Streaming Interface

 use Linux::Inotify2 ;

 # create a new object
 my $inotify = new Linux::Inotify2
    or die "Unable to create new inotify object: $!" ;

 # create watch
 $inotify->watch ("/etc/passwd", IN_ACCESS)
    or die "watch creation failed" ;

 while () {
   my @events = $inotify->read;
   unless (@events > 0) {
     print "read error: $!";
     last ;
   }
   printf "mask\t%d\n", $_->mask foreach @events ; 
 }

=head1 DESCRIPTION

This module implements an interface to the Linux 2.6.13 and later Inotify
file/directory change notification sytem.

It has a number of advantages over the Linux::Inotify module:

   - it is portable (Linux::Inotify only works on x86)
   - the equivalent of fullname works correctly
   - it is better documented
   - it has callback-style interface, which is better suited for
     integration.

=head2 The Linux::Inotify2 Class

=over 4

=cut

package Linux::Inotify2;

use Carp ();
use Fcntl ();
use Scalar::Util ();

use base 'Exporter';

BEGIN {
   $VERSION = '1.1';

   @constants = qw(
      IN_ACCESS IN_MODIFY IN_ATTRIB IN_CLOSE_WRITE
      IN_CLOSE_NOWRITE IN_OPEN IN_MOVED_FROM IN_MOVED_TO
      IN_CREATE IN_DELETE IN_DELETE_SELF IN_MOVE_SELF
      IN_ALL_EVENTS
      IN_UNMOUNT IN_Q_OVERFLOW IN_IGNORED
      IN_CLOSE IN_MOVE
      IN_ISDIR IN_ONESHOT IN_MASK_ADD IN_DONT_FOLLOW IN_ONLYDIR
   );

   @EXPORT = @constants;

   require XSLoader;
   XSLoader::load Linux::Inotify2, $VERSION;
}

=item my $inotify = new Linux::Inotify2

Create a new notify object and return it. A notify object is kind of a
container that stores watches on filesystem names and is responsible for
handling event data.

On error, C<undef> is returned and C<$!> will be set accordingly. The followign errors
are documented:

 ENFILE   The system limit on the total number of file descriptors has been reached.
 EMFILE   The user limit on the total number of inotify instances has been reached.
 ENOMEM   Insufficient kernel memory is available.

Example:

   my $inotify = new Linux::Inotify2
      or die "Unable to create new inotify object: $!";

=cut

sub new {
   my ($class) = @_;

   my $fd = inotify_init;

   return unless $fd >= 0;

   bless { fd => $fd }, $class
}

=item $watch = $inotify->watch ($name, $mask[, $cb])

Add a new watcher to the given notifier. The watcher will create events
on the pathname C<$name> as given in C<$mask>, which can be any of the
following constants (all exported by default) ORed together.

"file" refers to any filesystem object in the watch'ed object (always a
directory), that is files, directories, symlinks, device nodes etc., while
"object" refers to the object the watch has been set on itself:

 IN_ACCESS            object was accessed
 IN_MODIFY            object was modified
 IN_ATTRIB            object metadata changed
 IN_CLOSE_WRITE       writable fd to file / to object was closed
 IN_CLOSE_NOWRITE     readonly fd to file / to object closed
 IN_OPEN              object was opened
 IN_MOVED_FROM        file was moved from this object (directory)
 IN_MOVED_TO          file was moved to this object (directory)
 IN_CREATE            file was created in this object (directory)
 IN_DELETE            file was deleted from this object (directory)
 IN_DELETE_SELF       object itself was deleted
 IN_MOVE_SELF         object itself was moved
 IN_ALL_EVENTS        all of the above events

 IN_ONESHOT           only send event once
 IN_ONLYDIR           only watch the path if it is a directory
 IN_DONT_FOLLOW       don't follow a sym link
 IN_MASK_ADD          not supported with the current version of this module

 IN_CLOSE             same as IN_CLOSE_WRITE | IN_CLOSE_NOWRITE
 IN_MOVE              same as IN_MOVED_FROM | IN_MOVED_TO

C<$cb> is a perl code reference that, if given, is called for each
event. It receives a C<Linux::Inotify2::Event> object.

The returned C<$watch> object is of class C<Linux::Inotify2::Watch>.

On error, C<undef> is returned and C<$!> will be set accordingly. The
following errors are documented:

 EBADF    The given file descriptor is not valid.
 EINVAL   The given event mask contains no legal events.
 ENOMEM   Insufficient kernel memory was available.
 ENOSPC   The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource.
 EACCESS  Read access to the given file is not permitted.

Example, show when C</etc/passwd> gets accessed and/or modified once:

   $inotify->watch ("/etc/passwd", IN_ACCESS | IN_MODIFY, sub {
      my $e = shift;
      print "$e->{w}{name} was accessed\n" if $e->IN_ACCESS;
      print "$e->{w}{name} was modified\n" if $e->IN_MODIFY;
      print "$e->{w}{name} is no longer mounted\n" if $e->IN_UNMOUNT;
      print "events for $e->{w}{name} have been lost\n" if $e->IN_Q_OVERFLOW;

      $e->w->cancel;
   });

=cut

sub watch {
   my ($self, $name, $mask, $cb) = @_;

   my $wd = inotify_add_watch $self->{fd}, $name, $mask;

   return unless $wd >= 0;
   
   my $w = $self->{w}{$wd} = bless {
      inotify => $self,
      wd      => $wd,
      name    => $name,
      mask    => $mask,
      cb      => $cb,
   }, "Linux::Inotify2::Watch";

   Scalar::Util::weaken $w->{inotify};

   $w
}

=item $inotify->fileno

Returns the fileno for this notify object. You are responsible for calling
the C<poll> method when this fileno becomes ready for reading.

=cut

sub fileno {
   $_[0]{fd}
}

=item $inotify->blocking ($blocking)

Clears ($blocking true) or sets ($blocking false) the C<O_NONBLOCK> flag on the file descriptor.

=cut

sub blocking {
   my ($self, $blocking) = @_;

   inotify_blocking $self->{fd}, $blocking;
}

=item $count = $inotify->poll

Reads events from the kernel and handles them. If the notify fileno is
blocking (the default), then this method waits for at least one event
(and thus returns true unless an error occurs). Otherwise it returns
immediately when no pending events could be read.

Returns the count of events that have been handled.

=cut

sub poll {
   scalar &read
}

=item $count = $inotify->read

Reads events from the kernel. Blocks in blocking mode (default) until any
event arrives. Returns list of C<Linux::Inotify2::Event> objects or empty
list if none (non-blocking mode) or error occured ($! should be checked).

=cut

sub read {
   my ($self) = @_;

   my @ev = inotify_read $self->{fd};
   my @res;

   for (@ev) {
      my $w = $_->{w} = $self->{w}{$_->{wd}}
         or next; # no such watcher

      exists $self->{ignore}{$_->{wd}}
         and next; # watcher has been canceled

      bless $_, "Linux::Inotify2::Event";

      push @res, $_;

      $w->{cb}->($_) if $w->{cb};
      $w->cancel if $_->{mask} & (IN_IGNORED | IN_UNMOUNT | IN_ONESHOT);
   }

   delete $self->{ignore};

   @res
}

sub DESTROY {
   inotify_close $_[0]{fd}
}

=back

=head2 The Linux::Inotify2::Event Class

Objects of this class are handed as first argument to the watch
callback. It has the following members and methods:

=over 4

=item $event->w

=item $event->{w}

The watcher object for this event.

=item $event->name

=item $event->{name}

The path of the filesystem object, relative to the watch name.

=item $watch->fullname

Returns the "full" name of the relevant object, i.e. including the C<name>
member of the watcher (if the the watch is on a directory and a dir entry
is affected), or simply the C<name> member itself when the object is the
watch object itself.

=item $event->mask

=item $event->{mask}

The received event mask. In addition the the events described for
C<$inotify->watch>, the following flags (exported by default) can be set:

 IN_ISDIR             event object is a directory
 IN_Q_OVERFLOW        event queue overflowed

 # when any of the following flags are set,
 # then watchers for this event are automatically canceled
 IN_UNMOUNT           filesystem for watch'ed object was unmounted
 IN_IGNORED           file was ignored/is gone (no more events are delivered)
 IN_ONESHOT           only one event was generated

=item $event->IN_xxx

Returns a boolean that returns true if the event mask matches the
event. All of the C<IN_xxx> constants can be used as methods.

=item $event->cookie

=item $event->{cookie}

The event cookie to "synchronize two events". Normally zero, this value is
set when two events relating to the same file are generated. As far as I
know, this only happens for C<IN_MOVED_FROM> and C<IN_MOVED_TO> events, to
identify the old and new name of a file.

=back

=cut

package Linux::Inotify2::Event;

sub w       { $_[0]{w}      }
sub name    { $_[0]{name}   }
sub mask    { $_[0]{mask}   }
sub cookie  { $_[0]{cookie} }

sub fullname {
   length $_[0]{name}
      ? "$_[0]{w}{name}/$_[0]{name}"
      : $_[0]{w}{name};
}

for my $name (@Linux::Inotify2::constants) {
   my $mask = &{"Linux::Inotify2::$name"};

   *$name = sub { ($_[0]{mask} & $mask) == $mask };
}

=head2 The Linux::Inotify2::Watch Class

Watch objects are created by calling the C<watch> method of a notifier.

It has the following members and methods:

=over 4

=item $watch->name

=item $watch->{name}

The name as specified in the C<watch> call. For the object itself, this is
the empty string.  For directory watches, this is the name of the entry
without leading path elements.

=item $watch->mask

=item $watch->{mask}

The mask as specified in the C<watch> call.

=item $watch->cb ([new callback])

=item $watch->{cb}

The callback as specified in the C<watch> call. Can optionally be changed.

=item $watch->cancel

Cancels/removes this watch. Future events, even if already queued queued,
will not be handled and resources will be freed.

=back

=cut

package Linux::Inotify2::Watch;

sub name    { $_[0]{name} }
sub mask    { $_[0]{mask} }

sub cb {
   $_[0]{cb} = $_[1] if @_ > 1;
   $_[0]{cb}
}

sub cancel {
   my ($self) = @_;

   my $inotify = delete $self->{inotify}
      or return 1; # already canceled

   delete $inotify->{w}{$self->{wd}}; # we are no longer there
   $inotify->{ignore}{$self->{wd}} = 1; # ignore further events for one poll

   (Linux::Inotify2::inotify_rm_watch $inotify->{fd}, $self->{wd})
      ? 1 : undef
}

=head1 SEE ALSO

L<Linux::Inotify>.

=head1 AUTHOR

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut

1
Revision:	1.15
Committed:	Fri Sep 29 14:41:33 2006 UTC (19 years, 11 months ago) by root
Branch:	MAIN
CVS Tags:	rel-1_1
Changes since 1.14:	+5 -2 lines
Log Message:	* empty log message *
#	Content
1	=head1 NAME
2
3	Linux::Inotify2 - scalable directory/file change notification
4
5	=head1 SYNOPSIS
6
7	=head2 Callback interface
8
9	use Linux::Inotify2;
10
11	# create a new object
12	my $inotify = new Linux::Inotify2
13	or die "Unable to create new inotify object: $!";
14
15	# for Event:
16	Event->io (fd =>$inotify->fileno, poll => 'r', cb => sub { $inotify->poll });
17	# for Glib:
18	add_watch Glib::IO $inotify->fileno, in => sub { $inotify->poll };
19	# manually:
20	1 while $inotify->poll;
21
22	# add watchers
23	$inotify->watch ("/etc/passwd", IN_ACCESS, sub {
24	my $e = shift;
25	my $name = $e->fullname;
26	print "$name was accessed\n" if $e->IN_ACCESS;
27	print "$name is no longer mounted\n" if $e->IN_UNMOUNT;
28	print "$name is gone\n" if $e->IN_IGNORED;
29	print "events for $name have been lost\n" if $e->IN_Q_OVERFLOW;
30
31	# cancel this watcher: remove no further events
32	$e->w->cancel;
33	});
34
35	=head2 Streaming Interface
36
37	use Linux::Inotify2 ;
38
39	# create a new object
40	my $inotify = new Linux::Inotify2
41	or die "Unable to create new inotify object: $!" ;
42
43	# create watch
44	$inotify->watch ("/etc/passwd", IN_ACCESS)
45	or die "watch creation failed" ;
46
47	while () {
48	my @events = $inotify->read;
49	unless (@events > 0) {
50	print "read error: $!";
51	last ;
52	}
53	printf "mask\t%d\n", $_->mask foreach @events ;
54	}
55
56	=head1 DESCRIPTION
57
58	This module implements an interface to the Linux 2.6.13 and later Inotify
59	file/directory change notification sytem.
60
61	It has a number of advantages over the Linux::Inotify module:
62
63	- it is portable (Linux::Inotify only works on x86)
64	- the equivalent of fullname works correctly
65	- it is better documented
66	- it has callback-style interface, which is better suited for
67	integration.
68
69	=head2 The Linux::Inotify2 Class
70
71	=over 4
72
73	=cut
74
75	package Linux::Inotify2;
76
77	use Carp ();
78	use Fcntl ();
79	use Scalar::Util ();
80
81	use base 'Exporter';
82
83	BEGIN {
84	$VERSION = '1.1';
85
86	@constants = qw(
87	IN_ACCESS IN_MODIFY IN_ATTRIB IN_CLOSE_WRITE
88	IN_CLOSE_NOWRITE IN_OPEN IN_MOVED_FROM IN_MOVED_TO
89	IN_CREATE IN_DELETE IN_DELETE_SELF IN_MOVE_SELF
90	IN_ALL_EVENTS
91	IN_UNMOUNT IN_Q_OVERFLOW IN_IGNORED
92	IN_CLOSE IN_MOVE
93	IN_ISDIR IN_ONESHOT IN_MASK_ADD IN_DONT_FOLLOW IN_ONLYDIR
94	);
95
96	@EXPORT = @constants;
97
98	require XSLoader;
99	XSLoader::load Linux::Inotify2, $VERSION;
100	}
101
102	=item my $inotify = new Linux::Inotify2
103
104	Create a new notify object and return it. A notify object is kind of a
105	container that stores watches on filesystem names and is responsible for
106	handling event data.
107
108	On error, C<undef> is returned and C<$!> will be set accordingly. The followign errors
109	are documented:
110
111	ENFILE The system limit on the total number of file descriptors has been reached.
112	EMFILE The user limit on the total number of inotify instances has been reached.
113	ENOMEM Insufficient kernel memory is available.
114
115	Example:
116
117	my $inotify = new Linux::Inotify2
118	or die "Unable to create new inotify object: $!";
119
120	=cut
121
122	sub new {
123	my ($class) = @_;
124
125	my $fd = inotify_init;
126
127	return unless $fd >= 0;
128
129	bless { fd => $fd }, $class
130	}
131
132	=item $watch = $inotify->watch ($name, $mask[, $cb])
133
134	Add a new watcher to the given notifier. The watcher will create events
135	on the pathname C<$name> as given in C<$mask>, which can be any of the
136	following constants (all exported by default) ORed together.
137
138	"file" refers to any filesystem object in the watch'ed object (always a
139	directory), that is files, directories, symlinks, device nodes etc., while
140	"object" refers to the object the watch has been set on itself:
141
142	IN_ACCESS object was accessed
143	IN_MODIFY object was modified
144	IN_ATTRIB object metadata changed
145	IN_CLOSE_WRITE writable fd to file / to object was closed
146	IN_CLOSE_NOWRITE readonly fd to file / to object closed
147	IN_OPEN object was opened
148	IN_MOVED_FROM file was moved from this object (directory)
149	IN_MOVED_TO file was moved to this object (directory)
150	IN_CREATE file was created in this object (directory)
151	IN_DELETE file was deleted from this object (directory)
152	IN_DELETE_SELF object itself was deleted
153	IN_MOVE_SELF object itself was moved
154	IN_ALL_EVENTS all of the above events
155
156	IN_ONESHOT only send event once
157	IN_ONLYDIR only watch the path if it is a directory
158	IN_DONT_FOLLOW don't follow a sym link
159	IN_MASK_ADD not supported with the current version of this module
160
161	IN_CLOSE same as IN_CLOSE_WRITE \| IN_CLOSE_NOWRITE
162	IN_MOVE same as IN_MOVED_FROM \| IN_MOVED_TO
163
164	C<$cb> is a perl code reference that, if given, is called for each
165	event. It receives a C<Linux::Inotify2::Event> object.
166
167	The returned C<$watch> object is of class C<Linux::Inotify2::Watch>.
168
169	On error, C<undef> is returned and C<$!> will be set accordingly. The
170	following errors are documented:
171
172	EBADF The given file descriptor is not valid.
173	EINVAL The given event mask contains no legal events.
174	ENOMEM Insufficient kernel memory was available.
175	ENOSPC The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource.
176	EACCESS Read access to the given file is not permitted.
177
178	Example, show when C</etc/passwd> gets accessed and/or modified once:
179
180	$inotify->watch ("/etc/passwd", IN_ACCESS \| IN_MODIFY, sub {
181	my $e = shift;
182	print "$e->{w}{name} was accessed\n" if $e->IN_ACCESS;
183	print "$e->{w}{name} was modified\n" if $e->IN_MODIFY;
184	print "$e->{w}{name} is no longer mounted\n" if $e->IN_UNMOUNT;
185	print "events for $e->{w}{name} have been lost\n" if $e->IN_Q_OVERFLOW;
186
187	$e->w->cancel;
188	});
189
190	=cut
191
192	sub watch {
193	my ($self, $name, $mask, $cb) = @_;
194
195	my $wd = inotify_add_watch $self->{fd}, $name, $mask;
196
197	return unless $wd >= 0;
198
199	my $w = $self->{w}{$wd} = bless {
200	inotify => $self,
201	wd => $wd,
202	name => $name,
203	mask => $mask,
204	cb => $cb,
205	}, "Linux::Inotify2::Watch";
206
207	Scalar::Util::weaken $w->{inotify};
208
209	$w
210	}
211
212	=item $inotify->fileno
213
214	Returns the fileno for this notify object. You are responsible for calling
215	the C<poll> method when this fileno becomes ready for reading.
216
217	=cut
218
219	sub fileno {
220	$_[0]{fd}
221	}
222
223	=item $inotify->blocking ($blocking)
224
225	Clears ($blocking true) or sets ($blocking false) the C<O_NONBLOCK> flag on the file descriptor.
226
227	=cut
228
229	sub blocking {
230	my ($self, $blocking) = @_;
231
232	inotify_blocking $self->{fd}, $blocking;
233	}
234
235	=item $count = $inotify->poll
236
237	Reads events from the kernel and handles them. If the notify fileno is
238	blocking (the default), then this method waits for at least one event
239	(and thus returns true unless an error occurs). Otherwise it returns
240	immediately when no pending events could be read.
241
242	Returns the count of events that have been handled.
243
244	=cut
245
246	sub poll {
247	scalar &read
248	}
249
250	=item $count = $inotify->read
251
252	Reads events from the kernel. Blocks in blocking mode (default) until any
253	event arrives. Returns list of C<Linux::Inotify2::Event> objects or empty
254	list if none (non-blocking mode) or error occured ($! should be checked).
255
256	=cut
257
258	sub read {
259	my ($self) = @_;
260
261	my @ev = inotify_read $self->{fd};
262	my @res;
263
264	for (@ev) {
265	my $w = $_->{w} = $self->{w}{$_->{wd}}
266	or next; # no such watcher
267
268	exists $self->{ignore}{$_->{wd}}
269	and next; # watcher has been canceled
270
271	bless $_, "Linux::Inotify2::Event";
272
273	push @res, $_;
274
275	$w->{cb}->($_) if $w->{cb};
276	$w->cancel if $_->{mask} & (IN_IGNORED \| IN_UNMOUNT \| IN_ONESHOT);
277	}
278
279	delete $self->{ignore};
280
281	@res
282	}
283
284	sub DESTROY {
285	inotify_close $_[0]{fd}
286	}
287
288	=back
289
290	=head2 The Linux::Inotify2::Event Class
291
292	Objects of this class are handed as first argument to the watch
293	callback. It has the following members and methods:
294
295	=over 4
296
297	=item $event->w
298
299	=item $event->{w}
300
301	The watcher object for this event.
302
303	=item $event->name
304
305	=item $event->{name}
306
307	The path of the filesystem object, relative to the watch name.
308
309	=item $watch->fullname
310
311	Returns the "full" name of the relevant object, i.e. including the C<name>
312	member of the watcher (if the the watch is on a directory and a dir entry
313	is affected), or simply the C<name> member itself when the object is the
314	watch object itself.
315
316	=item $event->mask
317
318	=item $event->{mask}
319
320	The received event mask. In addition the the events described for
321	C<$inotify->watch>, the following flags (exported by default) can be set:
322
323	IN_ISDIR event object is a directory
324	IN_Q_OVERFLOW event queue overflowed
325
326	# when any of the following flags are set,
327	# then watchers for this event are automatically canceled
328	IN_UNMOUNT filesystem for watch'ed object was unmounted
329	IN_IGNORED file was ignored/is gone (no more events are delivered)
330	IN_ONESHOT only one event was generated
331
332	=item $event->IN_xxx
333
334	Returns a boolean that returns true if the event mask matches the
335	event. All of the C<IN_xxx> constants can be used as methods.
336
337	=item $event->cookie
338
339	=item $event->{cookie}
340
341	The event cookie to "synchronize two events". Normally zero, this value is
342	set when two events relating to the same file are generated. As far as I
343	know, this only happens for C<IN_MOVED_FROM> and C<IN_MOVED_TO> events, to
344	identify the old and new name of a file.
345
346	=back
347
348	=cut
349
350	package Linux::Inotify2::Event;
351
352	sub w { $_[0]{w} }
353	sub name { $_[0]{name} }
354	sub mask { $_[0]{mask} }
355	sub cookie { $_[0]{cookie} }
356
357	sub fullname {
358	length $_[0]{name}
359	? "$_[0]{w}{name}/$_[0]{name}"
360	: $_[0]{w}{name};
361	}
362
363	for my $name (@Linux::Inotify2::constants) {
364	my $mask = &{"Linux::Inotify2::$name"};
365
366	*$name = sub { ($_[0]{mask} & $mask) == $mask };
367	}
368
369	=head2 The Linux::Inotify2::Watch Class
370
371	Watch objects are created by calling the C<watch> method of a notifier.
372
373	It has the following members and methods:
374
375	=over 4
376
377	=item $watch->name
378
379	=item $watch->{name}
380
381	The name as specified in the C<watch> call. For the object itself, this is
382	the empty string. For directory watches, this is the name of the entry
383	without leading path elements.
384
385	=item $watch->mask
386
387	=item $watch->{mask}
388
389	The mask as specified in the C<watch> call.
390
391	=item $watch->cb ([new callback])
392
393	=item $watch->{cb}
394
395	The callback as specified in the C<watch> call. Can optionally be changed.
396
397	=item $watch->cancel
398
399	Cancels/removes this watch. Future events, even if already queued queued,
400	will not be handled and resources will be freed.
401
402	=back
403
404	=cut
405
406	package Linux::Inotify2::Watch;
407
408	sub name { $_[0]{name} }
409	sub mask { $_[0]{mask} }
410
411	sub cb {
412	$_[0]{cb} = $_[1] if @_ > 1;
413	$_[0]{cb}
414	}
415
416	sub cancel {
417	my ($self) = @_;
418
419	my $inotify = delete $self->{inotify}
420	or return 1; # already canceled
421
422	delete $inotify->{w}{$self->{wd}}; # we are no longer there
423	$inotify->{ignore}{$self->{wd}} = 1; # ignore further events for one poll
424
425	(Linux::Inotify2::inotify_rm_watch $inotify->{fd}, $self->{wd})
426	? 1 : undef
427	}
428
429	=head1 SEE ALSO
430
431	L<Linux::Inotify>.
432
433	=head1 AUTHOR
434
435	Marc Lehmann <schmorp@schmorp.de>
436	http://home.schmorp.de/
437
438	=cut
439
440	1