Class: INotify::Notifier
- Inherits:
-
Object
- Object
- INotify::Notifier
- Defined in:
- lib/rb-inotify/notifier.rb
Overview
Notifier wraps a single instance of inotify. It's possible to have more than one instance, but usually unnecessary.
Instance Attribute Summary collapse
-
#fd ⇒ Fixnum
readonly
The underlying file descriptor for this notifier.
Instance Method Summary collapse
- #close ⇒ Object
-
#initialize ⇒ Notifier
constructor
Creates a new Notifier.
-
#process ⇒ Object
Blocks until there are one or more filesystem events that this notifier has watchers registered for.
-
#run ⇒ Object
Starts the notifier watching for filesystem events.
-
#stop ⇒ Object
Stop watching for filesystem events.
-
#to_io ⇒ IO
Returns a Ruby IO object wrapping the underlying file descriptor.
-
#watch(path, *flags) {|event| ... } ⇒ Watcher
Watches a file or directory for changes, calling the callback when there are.
Constructor Details
#initialize ⇒ Notifier
Creates a new INotify::Notifier.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/rb-inotify/notifier.rb', line 42 def initialize @fd = Native.inotify_init @watchers = {} return unless @fd < 0 raise SystemCallError.new( "Failed to initialize inotify" + case FFI.errno when Errno::EMFILE::Errno; ": the user limit on the total number of inotify instances has been reached." when Errno::ENFILE::Errno; ": the system limit on the total number of file descriptors has been reached." when Errno::ENOMEM::Errno; ": insufficient kernel memory is available." else; "" end, FFI.errno) end |
Instance Attribute Details
#fd ⇒ Fixnum (readonly)
The underlying file descriptor for this notifier. This is a valid OS file descriptor, and can be used as such (except under JRuby -- see #to_io).
36 37 38 |
# File 'lib/rb-inotify/notifier.rb', line 36 def fd @fd end |
Instance Method Details
#close ⇒ Object
250 251 252 253 254 255 256 257 258 259 |
# File 'lib/rb-inotify/notifier.rb', line 250 def close return if Native.close(@fd) == 0 raise SystemCallError.new("Failed to properly close inotify socket" + case FFI.errno when Errno::EBADF::Errno; ": invalid or closed file descriptior" when Errno::EIO::Errno; ": an I/O error occured" end, FFI.errno) end |
#process ⇒ Object
Blocks until there are one or more filesystem events that this notifier has watchers registered for. Once there are events, the appropriate callbacks are called and this function returns.
214 215 216 |
# File 'lib/rb-inotify/notifier.rb', line 214 def process read_events.each {|event| event.callback!} end |
#run ⇒ Object
Starts the notifier watching for filesystem events. Blocks until #stop is called.
196 197 198 199 |
# File 'lib/rb-inotify/notifier.rb', line 196 def run @stop = false process until @stop end |
#stop ⇒ Object
Stop watching for filesystem events. That is, if we're in a #run loop, exit out as soon as we finish handling the events.
204 205 206 |
# File 'lib/rb-inotify/notifier.rb', line 204 def stop @stop = true end |
#to_io ⇒ IO
Returns a Ruby IO object wrapping the underlying file descriptor.
Since this file descriptor is fully functional (except under JRuby),
this IO object can be used in any way a Ruby-created IO object can.
This includes passing it to functions like #select
.
Note that this always returns the same IO object. Creating lots of IO objects for the same file descriptor can cause some odd problems.
This is not supported under JRuby. JRuby currently doesn't use native file descriptors for the IO object, so we can't use this file descriptor as a stand-in.
73 74 75 76 |
# File 'lib/rb-inotify/notifier.rb', line 73 def to_io raise NotImplementedError.new("INotify::Notifier#to_io is not supported under JRuby") if RUBY_PLATFORM =~ /java/ @io ||= IO.new(@fd) end |
#watch(path, *flags) {|event| ... } ⇒ Watcher
Watches a file or directory for changes, calling the callback when there are. This is only activated once #process or #run is called.
Note that by default, this does not recursively watch subdirectories
of the watched directory.
To do so, use the :recursive
flag.
Flags
:access
: A file is accessed (that is, read).
:attrib
: A file's metadata is changed (e.g. permissions, timestamps, etc).
:close_write
: A file that was opened for writing is closed.
:close_nowrite
: A file that was not opened for writing is closed.
:modify
: A file is modified.
:open
: A file is opened.
Directory-Specific Flags
These flags only apply when a directory is being watched.
:moved_from
: A file is moved out of the watched directory.
:moved_to
: A file is moved into the watched directory.
:create
: A file is created in the watched directory.
:delete
: A file is deleted in the watched directory.
:delete_self
: The watched file or directory itself is deleted.
:move_self
: The watched file or directory itself is moved.
Helper Flags
These flags are just combinations of the flags above.
:close
: Either :close_write
or :close_nowrite
is activated.
:move
: Either :moved_from
or :moved_to
is activated.
:all_events
: Any event above is activated.
Options Flags
These flags don't actually specify events. Instead, they specify options for the watcher.
:onlydir
: Only watch the path if it's a directory.
:dont_follow
: Don't follow symlinks.
:mask_add
: Add these flags to the pre-existing flags for this path.
:oneshot
: Only send the event once, then shut down the watcher.
:recursive
: Recursively watch any subdirectories that are created.
Note that this is a feature of rb-inotify,
rather than of inotify itself, which can only watch one level of a directory.
This means that the Event#name field
will contain only the basename of the modified file.
When using :recursive
, Event#absolute_name should always be used.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/rb-inotify/notifier.rb', line 176 def watch(path, *flags, &callback) return Watcher.new(self, path, *flags, &callback) unless flags.include?(:recursive) Dir.entries(path).each do |d| next if d == '.' || d == '..' d = File.join(path, d) watch(d, *flags, &callback) if File.directory?(d) end rec_flags = [:create, :moved_to] return watch(path, *((flags - [:recursive]) | rec_flags)) do |event| callback.call(event) if flags.include?(:all_events) || !(flags & event.flags).empty? next if (rec_flags & event.flags).empty? || !event.flags.include?(:isdir) watch(event.absolute_name, *flags, &callback) end end |