# directory_watcher-1.5.1 Documentation

Directory Watcher

    by Tim Pease
    http://codeforpeople.rubyforge.org/directory_watcher

## DESCRIPTION:

The directory watcher operates by scanning a directory at some interval and generating a list of files based on a user supplied glob pattern. As the file list changes from one interval to the next, events are generated and dispatched to registered observers. Three types of events are supported -- added, modified, and removed.

## FEATURES:

See DirectoryWatcher for detailed documentation and usage.

## REQUIREMENTS:

This is a pure ruby library. There are no requirements for using this code.

## INSTALL:

    sudo gem install directory_watcher

You will need have Mr Bones installed in order to develop or modify directory watcher.

    sudo gem install bones

## NOTES:

The support for EventMachine based file notifications is fairly new and experimental. Please feel free to experiment and report any issues on the github issue tracker.

    http://github.com/TwP/directory_watcher/issues

The support for Rev based file notifications is also fairly new and subject to the same disclaimer as the EventMachine functionality.

## LICENSE:

MIT License Copyright (c) 2007 - 2013

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## Files

- History.txt
- README.txt

## Classes/Modules

- DirectoryWatcher
- DirectoryWatcher::Collector
- DirectoryWatcher::Configuration
- DirectoryWatcher::CoolioScanner
- DirectoryWatcher::EmScanner
- DirectoryWatcher::Event
- DirectoryWatcher::EventableScanner
- DirectoryWatcher::FileStat
- DirectoryWatcher::Logable
- DirectoryWatcher::Notifier
- DirectoryWatcher::NullLogger
- DirectoryWatcher::Paths
- DirectoryWatcher::RevScanner
- DirectoryWatcher::Scan
- DirectoryWatcher::ScanAndQueue
- DirectoryWatcher::Scanner
- DirectoryWatcher::Threaded
- DirectoryWatcher::Version
- Object

## Methods

- ::default_logger — DirectoryWatcher::Logable
- ::default_options — DirectoryWatcher::Configuration
- ::for_removed_path — DirectoryWatcher::FileStat
- ::from_stats — DirectoryWatcher::Event
- ::new — DirectoryWatcher
- ::new — DirectoryWatcher::ScanAndQueue
- ::new — DirectoryWatcher::Scan
- ::new — DirectoryWatcher::RevScanner
- ::new — DirectoryWatcher::Notifier
- ::new — DirectoryWatcher::Configuration
- ::new — DirectoryWatcher::FileStat
- ::new — DirectoryWatcher::Scanner
- ::new — DirectoryWatcher::Collector
- ::new — DirectoryWatcher::EmScanner
- ::new — DirectoryWatcher::CoolioScanner
- ::new — DirectoryWatcher::Event
- ::new — DirectoryWatcher::EventableScanner
- #== — DirectoryWatcher::FileStat
- #add_observer — DirectoryWatcher
- #added? — DirectoryWatcher::Event
- #before_starting — DirectoryWatcher::Scanner
- #collection_queue — DirectoryWatcher::Collector
- #collection_queue — DirectoryWatcher::EventableScanner
- #continue_on_error= — DirectoryWatcher::Threaded
- #continue_on_error? — DirectoryWatcher::Threaded
- #count_observers — DirectoryWatcher
- #debug — DirectoryWatcher::NullLogger
- #delete_observer — DirectoryWatcher
- #delete_observers — DirectoryWatcher
- #dump_stats — DirectoryWatcher::Collector
- #eql? — DirectoryWatcher::FileStat
- #error — DirectoryWatcher::NullLogger
- #event_loop — DirectoryWatcher::RevScanner
- #event_loop — DirectoryWatcher::CoolioScanner
- #fatal — DirectoryWatcher::NullLogger
- #finished_iterations? — DirectoryWatcher::EventableScanner
- #finished_iterations? — DirectoryWatcher::Threaded
- #finished_scans? — DirectoryWatcher
- #glob — DirectoryWatcher
- #glob= — DirectoryWatcher::Configuration
- #glob= — DirectoryWatcher
- #info — DirectoryWatcher::NullLogger
- #interval — DirectoryWatcher::Threaded
- #interval — DirectoryWatcher::EventableScanner
- #interval — DirectoryWatcher
- #interval= — DirectoryWatcher::Threaded
- #interval= — DirectoryWatcher::Configuration
- #interval= — DirectoryWatcher
- #iterations — DirectoryWatcher::Threaded
- #join — DirectoryWatcher
- #join — DirectoryWatcher::EventableScanner
- #join — DirectoryWatcher::Threaded
- #lib_path — DirectoryWatcher::Paths
- #load! — DirectoryWatcher
- #load_stats — DirectoryWatcher::Collector
- #logger — DirectoryWatcher::Logable
- #logger= — DirectoryWatcher::Configuration
- #maximum_iterations — DirectoryWatcher
- #maximum_iterations — DirectoryWatcher::Threaded
- #maximum_iterations= — DirectoryWatcher::EventableScanner
- #maximum_iterations= — DirectoryWatcher
- #maximum_iterations= — DirectoryWatcher::Threaded
- #modified? — DirectoryWatcher::Event
- #notification_queue — DirectoryWatcher::Collector
- #on_modified — DirectoryWatcher::EventableScanner
- #on_removed — DirectoryWatcher::EventableScanner
- #on_scan — DirectoryWatcher::Collector
- #on_scan — DirectoryWatcher::EventableScanner
- #on_stat — DirectoryWatcher::Collector
- #order_by — DirectoryWatcher::Collector
- #path — DirectoryWatcher::Paths
- #pause — DirectoryWatcher
- #pause — DirectoryWatcher::Threaded
- #pause — DirectoryWatcher::EventableScanner
- #paused? — DirectoryWatcher::EventableScanner
- #persist — DirectoryWatcher
- #persist! — DirectoryWatcher
- #persist= — DirectoryWatcher::Configuration
- #persist= — DirectoryWatcher
- #persist? — DirectoryWatcher
- #pre_load? — DirectoryWatcher::Configuration
- #removed? — DirectoryWatcher::FileStat
- #removed? — DirectoryWatcher::Event
- #reset — DirectoryWatcher
- #results — DirectoryWatcher::Scan
- #resume — DirectoryWatcher::EventableScanner
- #resume — DirectoryWatcher
- #resume — DirectoryWatcher::Threaded
- #root_dir — DirectoryWatcher::Paths
- #run — DirectoryWatcher::Notifier
- #run — DirectoryWatcher::Scanner
- #run — DirectoryWatcher::Scan
- #run — DirectoryWatcher::EventableScanner
- #run — DirectoryWatcher::Threaded
- #run — DirectoryWatcher::Collector
- #run_once — DirectoryWatcher
- #running? — DirectoryWatcher
- #running? — DirectoryWatcher::Threaded
- #running? — DirectoryWatcher::EventableScanner
- #scan_and_queue — DirectoryWatcher::ScanAndQueue
- #scanner_class — DirectoryWatcher::Configuration
- #scans — DirectoryWatcher
- #setup_dir — DirectoryWatcher
- #sort_by — DirectoryWatcher::Collector
- #stable — DirectoryWatcher
- #stable= — DirectoryWatcher
- #stable= — DirectoryWatcher::Configuration
- #stable? — DirectoryWatcher::Event
- #stable_threshold — DirectoryWatcher::Collector
- #start — DirectoryWatcher::EventableScanner
- #start — DirectoryWatcher::Threaded
- #start — DirectoryWatcher
- #start_loop_with_attached_scan_timer — DirectoryWatcher::EmScanner
- #start_loop_with_attached_scan_timer — DirectoryWatcher::CoolioScanner
- #start_loop_with_attached_scan_timer — DirectoryWatcher::RevScanner
- #status — DirectoryWatcher::Threaded
- #stop — DirectoryWatcher::EventableScanner
- #stop — DirectoryWatcher::Threaded
- #stop — DirectoryWatcher
- #stop_loop — DirectoryWatcher::EmScanner
- #stop_loop — DirectoryWatcher::RevScanner
- #stop_loop — DirectoryWatcher::CoolioScanner
- #sub_path — DirectoryWatcher::Paths
- #to_s — DirectoryWatcher::FileStat
- #to_s — DirectoryWatcher::Event
- #version — DirectoryWatcher::Version
- #wait — DirectoryWatcher::Threaded
- #warn — DirectoryWatcher::NullLogger
- #with_load_path — DirectoryWatcher::Paths

[Validate]

Generated with the Darkfish Rdoc Generator 2.