text: <!DOCTYPE html>
  
  <html>
  <head>
  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
  
  <title>class Listen::Listener::Config - listen-3.0.3 Documentation</title>
  
  <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
  
  <script type="text/javascript">
    var rdoc_rel_prefix = "../../";
  </script>
  
  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
  <script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
  <script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
  <script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
  <script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
  <script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
  
  
  <body id="top" class="class">
  <nav id="metadata">
    <nav id="home-section" class="section">
    <h3 class="section-header">
      <a href="../../index.html">Home</a>
      <a href="../../table_of_contents.html#classes">Classes</a>
      <a href="../../table_of_contents.html#methods">Methods</a>
    </h3>
  </nav>
  
  
    <nav id="search-section" class="section project-section" class="initially-hidden">
    <form action="#" method="get" accept-charset="utf-8">
      <h3 class="section-header">
        <input type="text" name="search" placeholder="Search" id="search-field"
               title="Type to search, Up and Down to navigate, Enter to load">
      </h3>
    </form>
  
    <ul id="search-results" class="initially-hidden"></ul>
  </nav>
  
  
    
  
    <div id="file-metadata">
      <nav id="file-list-section" class="section">
    <h3 class="section-header">Defined In</h3>
    <ul>
      <li>lib/listen/listener/config.rb
    </ul>
  </nav>
  
      
    </div>
  
    <div id="class-metadata">
      
      <nav id="parent-class-section" class="section">
    <h3 class="section-header">Parent</h3>
    
    <p class="link">Object
    
  </nav>
  
      
      
      <!-- Method Quickref -->
  <nav id="method-list-section" class="section">
    <h3 class="section-header">Methods</h3>
  
    <ul class="link-list">
      
      <li ><a href="#method-c-new">::new</a>
      
      <li ><a href="#method-i-adapter_instance_options">#adapter_instance_options</a>
      
      <li ><a href="#method-i-adapter_select_options">#adapter_select_options</a>
      
      <li ><a href="#method-i-min_delay_between_events">#min_delay_between_events</a>
      
      <li ><a href="#method-i-relative-3F">#relative?</a>
      
      <li ><a href="#method-i-silencer_rules">#silencer_rules</a>
      
    </ul>
  </nav>
  
    </div>
  
    <div id="project-metadata">
      
      <nav id="classindex-section" class="section project-section">
    <h3 class="section-header">Class and Module Index</h3>
  
    <ul class="link-list">
    
      <li><a href="../../Listen.html">Listen</a>
    
      <li><a href="../../Listen/Adapter.html">Listen::Adapter</a>
    
      <li><a href="../../Listen/Adapter/BSD.html">Listen::Adapter::BSD</a>
    
      <li><a href="../../Listen/Adapter/Base.html">Listen::Adapter::Base</a>
    
      <li><a href="../../Listen/Adapter/Config.html">Listen::Adapter::Config</a>
    
      <li><a href="../../Listen/Adapter/Darwin.html">Listen::Adapter::Darwin</a>
    
      <li><a href="../../Listen/Adapter/Linux.html">Listen::Adapter::Linux</a>
    
      <li><a href="../../Listen/Adapter/Polling.html">Listen::Adapter::Polling</a>
    
      <li><a href="../../Listen/Adapter/Windows.html">Listen::Adapter::Windows</a>
    
      <li><a href="../../Listen/Backend.html">Listen::Backend</a>
    
      <li><a href="../../Listen/CLI.html">Listen::CLI</a>
    
      <li><a href="../../Listen/Change.html">Listen::Change</a>
    
      <li><a href="../../Listen/Change/Config.html">Listen::Change::Config</a>
    
      <li><a href="../../Listen/Directory.html">Listen::Directory</a>
    
      <li><a href="../../Listen/Event.html">Listen::Event</a>
    
      <li><a href="../../Listen/Event/Config.html">Listen::Event::Config</a>
    
      <li><a href="../../Listen/Event/Loop.html">Listen::Event::Loop</a>
    
      <li><a href="../../Listen/Event/Loop/Error.html">Listen::Event::Loop::Error</a>
    
      <li><a href="../../Listen/Event/Loop/Error/NotStarted.html">Listen::Event::Loop::Error::NotStarted</a>
    
      <li><a href="../../Listen/Event/Processor.html">Listen::Event::Processor</a>
    
      <li><a href="../../Listen/Event/Processor/Stopped.html">Listen::Event::Processor::Stopped</a>
    
      <li><a href="../../Listen/Event/Queue.html">Listen::Event::Queue</a>
    
      <li><a href="../../Listen/Event/Queue/Config.html">Listen::Event::Queue::Config</a>
    
      <li><a href="../../Listen/FSM.html">Listen::FSM</a>
    
      <li><a href="../../Listen/FSM/ClassMethods.html">Listen::FSM::ClassMethods</a>
    
      <li><a href="../../Listen/FSM/State.html">Listen::FSM::State</a>
    
      <li><a href="../../Listen/File.html">Listen::File</a>
    
      <li><a href="../../Listen/Forwarder.html">Listen::Forwarder</a>
    
      <li><a href="../../Listen/Internals.html">Listen::Internals</a>
    
      <li><a href="../../Listen/Internals/ThreadPool.html">Listen::Internals::ThreadPool</a>
    
      <li><a href="../../Listen/Listener.html">Listen::Listener</a>
    
      <li><a href="../../Listen/Listener/Config.html">Listen::Listener::Config</a>
    
      <li><a href="../../Listen/Logger.html">Listen::Logger</a>
    
      <li><a href="../../Listen/Options.html">Listen::Options</a>
    
      <li><a href="../../Listen/QueueOptimizer.html">Listen::QueueOptimizer</a>
    
      <li><a href="../../Listen/QueueOptimizer/Config.html">Listen::QueueOptimizer::Config</a>
    
      <li><a href="../../Listen/Record.html">Listen::Record</a>
    
      <li><a href="../../Listen/Record/Entry.html">Listen::Record::Entry</a>
    
      <li><a href="../../Listen/Record/SymlinkDetector.html">Listen::Record::SymlinkDetector</a>
    
      <li><a href="../../Listen/Record/SymlinkDetector/Error.html">Listen::Record::SymlinkDetector::Error</a>
    
      <li><a href="../../Listen/Silencer.html">Listen::Silencer</a>
    
      <li><a href="../../Listen/Silencer/Controller.html">Listen::Silencer::Controller</a>
    
    </ul>
  </nav>
  
    </div>
  </nav>
  
  <div id="documentation">
    <h1 class="class">class Listen::Listener::Config</h1>
  
    <div id="description" class="description">
      
    </div><!-- description -->
  
    
    
    
    <section id="5Buntitled-5D" class="documentation-section">
      
  
      
  
      
      <!-- Constants -->
      <section id="constants-list" class="section">
        <h3 class="section-header">Constants</h3>
        <dl>
        
          <dt id="DEFAULTS">DEFAULTS
          
          <dd class="description">
          
        
        </dl>
      </section>
      
  
      
  
      <!-- Methods -->
      
       <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
        <h3 class="section-header">Public Class Methods</h3>
  
      
        <div id="method-c-new" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">new</span><span
              class="method-args">(opts)</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="new-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 15</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">opts</span>)
    <span class="ruby-ivar">@options</span> = <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
    <span class="ruby-ivar">@relative</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:relative</span>]
    <span class="ruby-ivar">@min_delay_between_events</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:wait_for_delay</span>]
    <span class="ruby-ivar">@silencer_rules</span> = <span class="ruby-ivar">@options</span> <span class="ruby-comment"># silencer will extract what it needs</span>
  <span class="ruby-keyword">end</span></pre>
            </div><!-- new-source -->
            
          </div>
  
          
  
          
        </div><!-- new-method -->
  
      
      </section><!-- public-class-method-details -->
    
       <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
        <h3 class="section-header">Public Instance Methods</h3>
  
      
        <div id="method-i-adapter_instance_options" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">adapter_instance_options</span><span
              class="method-args">(klass)</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="adapter_instance_options-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 34</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">adapter_instance_options</span>(<span class="ruby-identifier">klass</span>)
    <span class="ruby-identifier">valid_keys</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-string">&#39;DEFAULTS&#39;</span>).<span class="ruby-identifier">keys</span>
    <span class="ruby-constant">Hash</span>[<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-identifier">valid_keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>) }]
  <span class="ruby-keyword">end</span></pre>
            </div><!-- adapter_instance_options-source -->
            
          </div>
  
          
  
          
        </div><!-- adapter_instance_options-method -->
  
      
        <div id="method-i-adapter_select_options" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">adapter_select_options</span><span
              class="method-args">()</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="adapter_select_options-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 39</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">adapter_select_options</span>
    <span class="ruby-identifier">valid_keys</span> = <span class="ruby-node">%w(force_polling polling_fallback_message)</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:to_sym</span>)
    <span class="ruby-constant">Hash</span>[<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-identifier">valid_keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>) }]
  <span class="ruby-keyword">end</span></pre>
            </div><!-- adapter_select_options-source -->
            
          </div>
  
          
  
          
        </div><!-- adapter_select_options-method -->
  
      
        <div id="method-i-min_delay_between_events" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">min_delay_between_events</span><span
              class="method-args">()</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="min_delay_between_events-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 26</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">min_delay_between_events</span>
    <span class="ruby-ivar">@min_delay_between_events</span>
  <span class="ruby-keyword">end</span></pre>
            </div><!-- min_delay_between_events-source -->
            
          </div>
  
          
  
          
        </div><!-- min_delay_between_events-method -->
  
      
        <div id="method-i-relative-3F" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">relative?</span><span
              class="method-args">()</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="relative-3F-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 22</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">relative?</span>
    <span class="ruby-ivar">@relative</span>
  <span class="ruby-keyword">end</span></pre>
            </div><!-- relative-3F-source -->
            
          </div>
  
          
  
          
        </div><!-- relative-3F-method -->
  
      
        <div id="method-i-silencer_rules" class="method-detail ">
          
          <div class="method-heading">
            <span class="method-name">silencer_rules</span><span
              class="method-args">()</span>
            
            <span class="method-click-advice">click to toggle source</span>
            
          </div>
          
  
          <div class="method-description">
            
            
            
            
  
            
            <div class="method-source-code" id="silencer_rules-source">
              <pre><span class="ruby-comment"># File lib/listen/listener/config.rb, line 30</span>
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">silencer_rules</span>
    <span class="ruby-ivar">@silencer_rules</span>
  <span class="ruby-keyword">end</span></pre>
            </div><!-- silencer_rules-source -->
            
          </div>
  
          
  
          
        </div><!-- silencer_rules-method -->
  
      
      </section><!-- public-instance-method-details -->
    
    </section><!-- 5Buntitled-5D -->
  
  </div><!-- documentation -->
  
  
  <footer id="validator-badges">
    <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
    <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
    <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
  </footer>
  
  