Module pyinotify :: Class ThreadedNotifier

[frames] | no frames]

Class ThreadedNotifier

source code

This notifier inherits from threading.Thread for instantiating a separate thread, and also inherits from Notifier, because it is a threaded notifier.

This class is only maintained for legacy reasons, everything possible with this class is also possible with Notifier, but Notifier is _better_ under many aspects (not threaded, can be daemonized, won't unnecessarily read for events).

Instance Methods

__init__(self, watch_manager, default_proc_fun=<ProcessEvent>, read_freq=0, treshold=0, timeout=10000)
Initialization, initialize base classes.

source code

stop(self)
Stop the notifier's loop.

source code

loop(self)
Thread's main loop.

source code

run(self)
Start the thread's loop: read and process events until the method stop() is called.

source code

Inherited from threading.Thread: __repr__, getName, isAlive, isDaemon, join, setDaemon, setName, start

Inherited from threading.Thread (private): _set_daemon

Inherited from threading._Verbose (private): _note

Inherited from Notifier: check_events, proc_fun, process_events, read_events

Inherited from Notifier (private): _sleep

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Properties

Inherited from object: __class__

Method Details

init(self, watch_manager, default_proc_fun=<ProcessEvent>, read_freq=0, treshold=0, timeout=10000)
(Constructor)

Initialization, initialize base classes. read_freq, treshold and timeout parameters are used when looping.

Parameters:

watch_manager (WatchManager instance) - Watch Manager.
default_proc_fun (instance of ProcessEvent) - Default processing method.
read_freq (int) - if read_freq == 0, events are read asap, if read_freq is > 0, this thread sleeps max(0, read_freq - timeout) seconds.
treshold (int) - File descriptor will be read only if its size to read is >= treshold. If != 0, you likely want to use it in combination with read_freq because without that you keep looping without really reading anything and that until the amount to read is >= treshold. At least with read_freq you may sleep.
timeout (int) - see http://docs.python.org/lib/poll-objects.html#poll-objects Read the corresponding comment in the source code before changing it.

Overrides: threading.Thread.__init__

stop(self)

Stop the notifier's loop. Stop notification. Join the thread.

Overrides: Notifier.stop

loop(self)

Thread's main loop. don't meant to be called by user directly. Call start() instead.

Events are read only once time every min(read_freq, timeout) seconds at best and only if the size to read is >= treshold.

Overrides: Notifier.loop

run(self)

Start the thread's loop: read and process events until the method stop() is called. Never call this method directly, instead call the start() method inherited from threading.Thread, which then will call run().

Overrides: threading.Thread.run