Class Notifier

Initialization. read_freq, threshold and timeout parameters are used when looping.

Parameters:

• watch_manager (WatchManager instance) - Watch Manager.
• default_proc_fun (instance of ProcessEvent) - Default processing method. If None, a new instance of PrintAllEvents will be assigned.
• read_freq (int) - if read_freq == 0, events are read asap, if read_freq is > 0, this thread sleeps max(0, read_freq - (timeout / 1000)) seconds. But if timeout is None it may be different because poll is blocking waiting for something to read.
• threshold (int) - File descriptor will be read only if the accumulated size to read becomes >= threshold. If != 0, you likely want to use it in combination with an appropriate value for read_freq because without that you would keep looping without really reading anything and that until the amount of events to read is >= threshold. At least with read_freq set you might sleep.
• timeout (int) - see read_freq above. If provided, it must be set in milliseconds. See https://docs.python.org/2/library/select.html#polling-objects

Overrides: object.__init__

Append a raw event to the event queue.

Parameters:

• event (_RawEvent instance.) - An event.

Coalescing events. Events are usually processed by batchs, their size depend on various factors. Thus, before processing them, events received from inotify are aggregated in a fifo queue. If this coalescing option is enabled events are filtered based on their unicity, only unique events are enqueued, doublons are discarded. An event is unique when the combination of its fields (wd, mask, cookie, name) is unique among events of a same batch. After a batch of events is processed any events is accepted again. By default this option is disabled, you have to explictly call this function to turn it on.

Parameters:

• coalesce (Bool) - Optional new coalescing value. True by default.

Check for new events available to read, blocks up to timeout milliseconds.

Parameters:

• timeout (int) - If specified it overrides the corresponding instance attribute _timeout. timeout must be sepcified in milliseconds.

Returns: bool

New events to read.

Routine for processing events from queue by calling their associated proccessing method (an instance of ProcessEvent). It also does internal processings, to keep the system updated.

Events are read only one time every min(read_freq, timeout) seconds at best and only if the size to read is >= threshold. After this method returns it must not be called again for the same instance.

Parameters:

• callback (callable object or function) - Functor called after each event processing iteration. Expects to receive the notifier object (self) as first parameter. If this function returns True the loop is immediately terminated otherwise the loop method keeps looping.
• daemonize (boolean) - This thread is daemonized if set to True.
• args (various) - Optional and relevant only if daemonize is True. Remaining keyworded arguments are directly passed to daemonize see __daemonize() method. If pid_file=None or is set to a pathname the caller must ensure the file does not exist before this method is called otherwise an exception pyinotify.NotifierError will be raised. If pid_file=False it is still daemonized but the pid is not written in any file.

Close inotify's instance (close its file descriptor). It destroys all existing watches, pending events,... This method is automatically called at the end of loop(). Afterward it is invalid to access this instance.