Class: Listen::Adapters::Linux

Inherits:
Listen::Adapter show all
Defined in:
lib/listen/adapters/linux.rb

Overview

Listener implementation for Linux ‘inotify`.

Constant Summary collapse

EVENTS =

Watched inotify events

See Also:

%w[recursive attrib close modify move create delete delete_self move_self]
INOTIFY_LIMIT_MESSAGE =

The message to show when the limit of inotify watchers is not enough

<<-EOS.gsub(/^\s*/, '')
  Listen error: unable to monitor directories for changes.

  Please head to https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
  for information on how to solve this issue.
EOS

Constants inherited from Listen::Adapter

Listen::Adapter::DEFAULT_LATENCY, Listen::Adapter::POLLING_FALLBACK_MESSAGE

Instance Attribute Summary

Attributes inherited from Listen::Adapter

#directories, #latency, #paused

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Listen::Adapter

select_and_initialize, #started?, usable_and_works?, #wait_for_callback, works?

Constructor Details

#initialize(directories, options = {}, &callback) ⇒ Linux

Initializes the Adapter. See Listen::Adapter#initialize for more info.



26
27
28
29
30
31
 
# File 'lib/listen/adapters/linux.rb', line 26

def initialize(directories, options = {}, &callback)
  super
  @worker = init_worker
rescue Errno::ENOSPC
  abort(INOTIFY_LIMIT_MESSAGE)
end

Class Method Details

.usable? ⇒ Boolean

Check if the adapter is usable on the current OS.

Returns:

  • (Boolean) —

    whether usable or not



65
66
67
68
69
70
71
72
 
# File 'lib/listen/adapters/linux.rb', line 65

def self.usable?
  return false unless RbConfig::CONFIG['target_os'] =~ /linux/i

  require 'rb-inotify'
  true
rescue LoadError
  false
end

Instance Method Details

#start(blocking = true) ⇒ Object

Starts the adapter.

Parameters:

  • blocking (Boolean) (defaults to: true) —

    whether or not to block the current thread after starting



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/listen/adapters/linux.rb', line 37

def start(blocking = true)
  @mutex.synchronize do
    return if @stop == false
    super
  end

  @worker_thread = Thread.new { @worker.run }
  @poll_thread   = Thread.new { poll_changed_dirs }
  @poll_thread.join if blocking
end

#stop ⇒ Object

Stops the adapter.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/listen/adapters/linux.rb', line 50

def stop
  @mutex.synchronize do
    return if @stop == true
    super
  end

  @worker.stop
  Thread.kill(@worker_thread) if @worker_thread
  @poll_thread.join
end