cvsroot/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: $!";
 
 # 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;
 });

 # integration into AnyEvent (works with EV, Glib, Tk, POE...)
 my $inotify_w = AnyEvent->io (
    fh => $inofity->fileno, poll => 'r', cb => sub { $inotify->poll }
 );

 # manual event loop
 1 while $inotify->poll;

=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 system.

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 common::sense;

use base 'Exporter';

BEGIN {
   our $VERSION = '1.22';
   our @EXPORT = 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
   );

   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 file system names and is responsible for
handling event data.

On error, C<undef> is returned and C<$!> will be set accordingly. The
following 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 file system object in the watched object (always a
directory), that is files, directories, symlinks, device nodes etc., while
"object" refers to the object the watcher 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 file descriptor for this notify object. When in non-blocking
mode, you are responsible for calling the C<poll> method when this file
descriptor 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 file
descriptor 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 @events = $inotify->read

Reads events from the kernel. Blocks when the file descriptor is 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 occurred ($! should be checked).

Normally you shouldn't use this function, but instead use watcher
callbacks and call C<< ->poll >>.

=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 | IN_DELETE_SELF);
   }

   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 watcher
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 file system object, relative to the watched name.

=item $event->fullname

Returns the "full" name of the relevant object, i.e. including the C<name>
member of the watcher (if the watch object is on a directory and a
directory 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 to 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 watched 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 contains any events
specified by the mask. 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::EXPORT) {
   my $mask = &{"Linux::Inotify2::$name"};

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

=head2 The Linux::Inotify2::Watch Class

Watcher 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 watcher. 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<AnyEvent>, L<Linux::Inotify>.

=head1 AUTHOR

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

=cut

1
Revision:	1.24
Committed:	Tue Jun 14 06:41:51 2011 UTC (15 years, 3 months ago) by root
Branch:	MAIN
CVS Tags:	rel-1_22
Changes since 1.23:	+34 -28 lines
Log Message:	1.22
#	User	Rev	Content
1	root	1.1	=head1 NAME
2
3			Linux::Inotify2 - scalable directory/file change notification
4
5			=head1 SYNOPSIS
6
7	root	1.19	=head2 Callback Interface
8	root	1.11
9	root	1.1	use Linux::Inotify2;
10
11	root	1.4	# create a new object
12			my $inotify = new Linux::Inotify2
13	root	1.19	or die "unable to create new inotify object: $!";
14	root	1.4
15			# add watchers
16			$inotify->watch ("/etc/passwd", IN_ACCESS, sub {
17			my $e = shift;
18			my $name = $e->fullname;
19			print "$name was accessed\n" if $e->IN_ACCESS;
20			print "$name is no longer mounted\n" if $e->IN_UNMOUNT;
21			print "$name is gone\n" if $e->IN_IGNORED;
22			print "events for $name have been lost\n" if $e->IN_Q_OVERFLOW;
23
24	root	1.11	# cancel this watcher: remove no further events
25	root	1.4	$e->w->cancel;
26			});
27
28	root	1.20	# integration into AnyEvent (works with EV, Glib, Tk, POE...)
29			my $inotify_w = AnyEvent->io (
30			fh => $inofity->fileno, poll => 'r', cb => sub { $inotify->poll }
31	root	1.17	);
32
33			# manual event loop
34			1 while $inotify->poll;
35
36	root	1.11	=head2 Streaming Interface
37
38			use Linux::Inotify2 ;
39
40			# create a new object
41			my $inotify = new Linux::Inotify2
42			or die "Unable to create new inotify object: $!" ;
43
44			# create watch
45			$inotify->watch ("/etc/passwd", IN_ACCESS)
46			or die "watch creation failed" ;
47
48			while () {
49			my @events = $inotify->read;
50			unless (@events > 0) {
51			print "read error: $!";
52			last ;
53			}
54			printf "mask\t%d\n", $_->mask foreach @events ;
55			}
56
57	root	1.1	=head1 DESCRIPTION
58
59	root	1.3	This module implements an interface to the Linux 2.6.13 and later Inotify
60	root	1.24	file/directory change notification system.
61	root	1.2
62	root	1.3	It has a number of advantages over the Linux::Inotify module:
63	root	1.2
64			- it is portable (Linux::Inotify only works on x86)
65			- the equivalent of fullname works correctly
66			- it is better documented
67			- it has callback-style interface, which is better suited for
68			integration.
69
70	root	1.6	=head2 The Linux::Inotify2 Class
71
72	root	1.1	=over 4
73
74			=cut
75
76			package Linux::Inotify2;
77
78			use Carp ();
79	root	1.11	use Fcntl ();
80	root	1.1	use Scalar::Util ();
81
82	root	1.20	use common::sense;
83
84	root	1.1	use base 'Exporter';
85
86			BEGIN {
87	root	1.24	our $VERSION = '1.22';
88	root	1.20	our @EXPORT = qw(
89	root	1.1	IN_ACCESS IN_MODIFY IN_ATTRIB IN_CLOSE_WRITE
90			IN_CLOSE_NOWRITE IN_OPEN IN_MOVED_FROM IN_MOVED_TO
91	root	1.9	IN_CREATE IN_DELETE IN_DELETE_SELF IN_MOVE_SELF
92	root	1.1	IN_ALL_EVENTS
93			IN_UNMOUNT IN_Q_OVERFLOW IN_IGNORED
94			IN_CLOSE IN_MOVE
95	root	1.15	IN_ISDIR IN_ONESHOT IN_MASK_ADD IN_DONT_FOLLOW IN_ONLYDIR
96	root	1.1	);
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	root	1.24	container that stores watches on file system names and is responsible for
106	root	1.1	handling event data.
107
108	root	1.22	On error, C<undef> is returned and C<$!> will be set accordingly. The
109			following errors are documented:
110	root	1.1
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	root	1.4	Example:
116
117			my $inotify = new Linux::Inotify2
118			or die "Unable to create new inotify object: $!";
119
120	root	1.1	=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	root	1.11	=item $watch = $inotify->watch ($name, $mask[, $cb])
133	root	1.1
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	root	1.4	following constants (all exported by default) ORed together.
137
138	root	1.24	"file" refers to any file system object in the watched object (always a
139	root	1.4	directory), that is files, directories, symlinks, device nodes etc., while
140	root	1.24	"object" refers to the object the watcher has been set on itself:
141	root	1.4
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	root	1.9	IN_MOVE_SELF object itself was moved
154	root	1.4	IN_ALL_EVENTS all of the above events
155	root	1.1
156			IN_ONESHOT only send event once
157	root	1.15	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	root	1.1
161	root	1.4	IN_CLOSE same as IN_CLOSE_WRITE \| IN_CLOSE_NOWRITE
162			IN_MOVE same as IN_MOVED_FROM \| IN_MOVED_TO
163	root	1.1
164	root	1.11	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	root	1.1
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	root	1.13	}, "Linux::Inotify2::Watch";
206	root	1.1
207			Scalar::Util::weaken $w->{inotify};
208
209			$w
210			}
211
212	root	1.4	=item $inotify->fileno
213	root	1.1
214	root	1.24	Returns the file descriptor for this notify object. When in non-blocking
215			mode, you are responsible for calling the C<poll> method when this file
216			descriptor becomes ready for reading.
217	root	1.1
218			=cut
219
220			sub fileno {
221			$_[0]{fd}
222			}
223
224	root	1.11	=item $inotify->blocking ($blocking)
225
226			Clears ($blocking true) or sets ($blocking false) the C<O_NONBLOCK> flag on the file descriptor.
227
228			=cut
229
230			sub blocking {
231			my ($self, $blocking) = @_;
232
233			inotify_blocking $self->{fd}, $blocking;
234			}
235
236	root	1.4	=item $count = $inotify->poll
237	root	1.1
238	root	1.24	Reads events from the kernel and handles them. If the notify file
239			descriptor is blocking (the default), then this method waits for at least
240			one event (and thus returns true unless an error occurs). Otherwise it
241			returns immediately when no pending events could be read.
242	root	1.1
243			Returns the count of events that have been handled.
244
245			=cut
246
247			sub poll {
248	root	1.11	scalar &read
249			}
250
251	root	1.24	=item @events = $inotify->read
252	root	1.11
253	root	1.24	Reads events from the kernel. Blocks when the file descriptor is in
254			blocking mode (default) until any event arrives. Returns list of
255			C<Linux::Inotify2::Event> objects or empty list if none (non-blocking
256			mode) or error occurred ($! should be checked).
257
258			Normally you shouldn't use this function, but instead use watcher
259			callbacks and call C<< ->poll >>.
260	root	1.11
261			=cut
262
263			sub read {
264	root	1.1	my ($self) = @_;
265
266	root	1.4	my @ev = inotify_read $self->{fd};
267	root	1.11	my @res;
268	root	1.4
269			for (@ev) {
270			my $w = $_->{w} = $self->{w}{$_->{wd}}
271	root	1.1	or next; # no such watcher
272	root	1.4
273			exists $self->{ignore}{$_->{wd}}
274			and next; # watcher has been canceled
275
276	root	1.13	bless $_, "Linux::Inotify2::Event";
277	root	1.12
278	root	1.11	push @res, $_;
279
280	root	1.12	$w->{cb}->($_) if $w->{cb};
281	root	1.16	$w->cancel if $_->{mask} & (IN_IGNORED \| IN_UNMOUNT \| IN_ONESHOT \| IN_DELETE_SELF);
282	root	1.1	}
283	root	1.4
284			delete $self->{ignore};
285
286	root	1.11	@res
287	root	1.1	}
288
289			sub DESTROY {
290			inotify_close $_[0]{fd}
291			}
292
293			=back
294
295			=head2 The Linux::Inotify2::Event Class
296
297	root	1.24	Objects of this class are handed as first argument to the watcher
298	root	1.1	callback. It has the following members and methods:
299
300			=over 4
301
302			=item $event->w
303
304			=item $event->{w}
305
306			The watcher object for this event.
307
308			=item $event->name
309
310			=item $event->{name}
311
312	root	1.24	The path of the file system object, relative to the watched name.
313	root	1.1
314	root	1.23	=item $event->fullname
315	root	1.1
316			Returns the "full" name of the relevant object, i.e. including the C<name>
317	root	1.24	member of the watcher (if the watch object is on a directory and a
318			directory entry is affected), or simply the C<name> member itself when the
319			object is the watch object itself.
320	root	1.1
321			=item $event->mask
322
323			=item $event->{mask}
324
325	root	1.24	The received event mask. In addition to the events described for C<<
326			$inotify->watch >>, the following flags (exported by default) can be set:
327	root	1.1
328	root	1.4	IN_ISDIR event object is a directory
329			IN_Q_OVERFLOW event queue overflowed
330
331	root	1.10	# when any of the following flags are set,
332			# then watchers for this event are automatically canceled
333	root	1.24	IN_UNMOUNT filesystem for watched object was unmounted
334	root	1.4	IN_IGNORED file was ignored/is gone (no more events are delivered)
335	root	1.10	IN_ONESHOT only one event was generated
336	root	1.1
337			=item $event->IN_xxx
338
339	root	1.24	Returns a boolean that returns true if the event mask contains any events
340			specified by the mask. All of the C<IN_xxx> constants can be used as
341			methods.
342	root	1.1
343			=item $event->cookie
344
345			=item $event->{cookie}
346
347	root	1.10	The event cookie to "synchronize two events". Normally zero, this value is
348			set when two events relating to the same file are generated. As far as I
349			know, this only happens for C<IN_MOVED_FROM> and C<IN_MOVED_TO> events, to
350			identify the old and new name of a file.
351	root	1.1
352			=back
353
354			=cut
355
356			package Linux::Inotify2::Event;
357
358			sub w { $_[0]{w} }
359			sub name { $_[0]{name} }
360			sub mask { $_[0]{mask} }
361			sub cookie { $_[0]{cookie} }
362
363			sub fullname {
364			length $_[0]{name}
365			? "$_[0]{w}{name}/$_[0]{name}"
366			: $_[0]{w}{name};
367			}
368
369	root	1.20	for my $name (@Linux::Inotify2::EXPORT) {
370	root	1.1	my $mask = &{"Linux::Inotify2::$name"};
371
372	root	1.24	*$name = sub { $_[0]{mask} & $mask };
373	root	1.1	}
374
375			=head2 The Linux::Inotify2::Watch Class
376
377	root	1.24	Watcher objects are created by calling the C<watch> method of a notifier.
378	root	1.1
379			It has the following members and methods:
380
381	root	1.14	=over 4
382
383	root	1.1	=item $watch->name
384
385			=item $watch->{name}
386
387			The name as specified in the C<watch> call. For the object itself, this is
388			the empty string. For directory watches, this is the name of the entry
389			without leading path elements.
390
391			=item $watch->mask
392
393			=item $watch->{mask}
394
395			The mask as specified in the C<watch> call.
396
397			=item $watch->cb ([new callback])
398
399			=item $watch->{cb}
400
401			The callback as specified in the C<watch> call. Can optionally be changed.
402
403			=item $watch->cancel
404
405	root	1.24	Cancels/removes this watcher. Future events, even if already queued queued,
406	root	1.1	will not be handled and resources will be freed.
407
408	root	1.14	=back
409
410	root	1.1	=cut
411
412			package Linux::Inotify2::Watch;
413
414			sub name { $_[0]{name} }
415			sub mask { $_[0]{mask} }
416
417			sub cb {
418			$_[0]{cb} = $_[1] if @_ > 1;
419			$_[0]{cb}
420			}
421
422			sub cancel {
423			my ($self) = @_;
424
425	root	1.4	my $inotify = delete $self->{inotify}
426			or return 1; # already canceled
427
428			delete $inotify->{w}{$self->{wd}}; # we are no longer there
429			$inotify->{ignore}{$self->{wd}} = 1; # ignore further events for one poll
430
431			(Linux::Inotify2::inotify_rm_watch $inotify->{fd}, $self->{wd})
432	root	1.1	? 1 : undef
433			}
434
435			=head1 SEE ALSO
436
437	root	1.19	L<AnyEvent>, L<Linux::Inotify>.
438	root	1.1
439			=head1 AUTHOR
440
441			Marc Lehmann <schmorp@schmorp.de>
442			http://home.schmorp.de/
443
444			=cut
445
446			1