class Puppet::Util::WatchedFile

Monitor a given file for changes on a periodic interval. Changes are detected by looking for a change in the file ctime.

Attributes

filename[R]

@!attribute [r] filename

@return [String] The fully qualified path to the file.

Public Instance Methods

changed?() click to toggle source

@return [true, false] If the file has changed since it was last checked.

# File lib/puppet/util/watched_file.rb, line 24
def changed?
  @info.changed?
end

to_s() click to toggle source

# File lib/puppet/util/watched_file.rb, line 34
def to_s
  "<WatchedFile: filename = #{@filename}, timeout = #{@timer.timeout}>"
end

to_str() click to toggle source

Allow this to be used as the name of the file being watched in various other methods (such as Puppet::FileSystem.exist?)

# File lib/puppet/util/watched_file.rb, line 30
def to_str
  @filename
end

Public Class Methods

new(filename, timer = Puppet::Util::Watcher::Timer.new(Puppet[:filetimeout])) click to toggle source

@param filename [String] The fully qualified path to the file. @param timer [Puppet::Util::Watcher::Timer] The polling interval for checking for file

changes. Setting the timeout to a negative value will treat the file as
always changed. Defaults to `Puppet[:filetimeout]`

# File lib/puppet/util/watched_file.rb, line 14
def initialize(filename, timer = Puppet::Util::Watcher::Timer.new(Puppet[:filetimeout]))
  @filename = filename
  @timer = timer

  @info = Puppet::Util::Watcher::PeriodicWatcher.new(
    Puppet::Util::Watcher::Common.file_ctime_change_watcher(@filename),
    timer)
end