Class | EventMachine::FileWatch |
In: |
lib/em/file_watch.rb
|
Parent: | Connection |
Utility class that is useful for file monitoring. Supported events are
@note On Mac OS X, file watching only works when kqueue is enabled
Cmodified | = | 'modified'.freeze | @private | |
Cdeleted | = | 'deleted'.freeze | @private | |
Cmoved | = | 'moved'.freeze | @private |
Will be called when the file is deleted. Supposed to be redefined by subclasses. When the file is deleted, stop_watching will be called after this to make sure everything is cleaned up correctly.
@note On Linux (with {en.wikipedia.org/wiki/Inotify inotify}), this method will not be called until all open file descriptors to
the file have been closed.
@abstract
Returns the path that is being monitored.
@note Current implementation does not pick up on the new filename after a rename occurs.
@return [String] @see EventMachine.watch_file
Discontinue monitoring of the file.
This involves cleaning up the underlying monitoring details with kqueue/inotify, and in turn firing {EventMachine::Connection#unbind}. This will be called automatically when a file is deleted. User code may call it as well.