Qt 4.8
Signals | Public Functions | Public Variables | List of all members
QWindowsFileSystemWatcherEngineThread Class Reference

#include <qfilesystemwatcher_win_p.h>

Inheritance diagram for QWindowsFileSystemWatcherEngineThread:
QThread QObject

Signals

void directoryChanged (const QString &path, bool removed)
 
void fileChanged (const QString &path, bool removed)
 
- Signals inherited from QThread
void finished ()
 This signal is emitted when the thread has finished executing. More...
 
void started ()
 This signal is emitted when the thread starts executing. More...
 
void terminated ()
 This signal is emitted when the thread is terminated. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

 QWindowsFileSystemWatcherEngineThread ()
 
void run ()
 The starting point for the thread. More...
 
void stop ()
 
void wakeup ()
 
 ~QWindowsFileSystemWatcherEngineThread ()
 
- Public Functions inherited from QThread
void exit (int retcode=0)
 Tells the thread's event loop to exit with a return code. More...
 
bool isFinished () const
 Returns true if the thread is finished; otherwise returns false. More...
 
bool isRunning () const
 Returns true if the thread is running; otherwise returns false. More...
 
Priority priority () const
 Returns the priority for a running thread. More...
 
 QThread (QObject *parent=0)
 Constructs a new QThread to manage a new thread. More...
 
void setPriority (Priority priority)
 This function sets the priority for a running thread. More...
 
void setStackSize (uint stackSize)
 Sets the maximum stack size for the thread to stackSize. More...
 
uint stackSize () const
 Returns the maximum stack size for the thread (if set with setStackSize()); otherwise returns zero. More...
 
bool wait (unsigned long time=ULONG_MAX)
 Blocks the thread until either of these conditions is met: More...
 
 ~QThread ()
 Destroys the QThread. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Public Variables

QHash< QString, QWindowsFileSystemWatcherEngine::HandlehandleForDir
 
QVector< HANDLE > handles
 
int msg
 
QMutex mutex
 
QHash< HANDLE, QHash< QString, QWindowsFileSystemWatcherEngine::PathInfo > > pathInfoForHandle
 

Additional Inherited Members

- Public Types inherited from QThread
enum  Priority {
  IdlePriority, LowestPriority, LowPriority, NormalPriority,
  HighPriority, HighestPriority, TimeCriticalPriority, InheritPriority
}
 This enum type indicates how the operating system should schedule newly created threads. More...
 
- Public Slots inherited from QThread
void quit ()
 Tells the thread's event loop to exit with return code 0 (success). More...
 
void start (Priority=InheritPriority)
 Begins execution of the thread by calling run(). More...
 
void terminate ()
 Terminates the execution of the thread. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Static Public Functions inherited from QThread
static QThreadcurrentThread ()
 Returns a pointer to a QThread which manages the currently executing thread. More...
 
static Qt::HANDLE currentThreadId ()
 Returns the thread handle of the currently executing thread. More...
 
static int idealThreadCount ()
 Returns the ideal number of threads that can be run on the system. More...
 
static void yieldCurrentThread ()
 Yields execution of the current thread to another runnable thread, if any. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QThread
int exec ()
 Enters the event loop and waits until exit() is called, returning the value that was passed to exit(). More...
 
 QThread (QThreadPrivate &dd, QObject *parent=0)
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Static Protected Functions inherited from QThread
static void msleep (unsigned long)
 Forces the current thread to sleep for msecs milliseconds. More...
 
static void setTerminationEnabled (bool enabled=true)
 Enables or disables termination of the current thread based on the enabled parameter. More...
 
static void sleep (unsigned long)
 Forces the current thread to sleep for secs seconds. More...
 
static void usleep (unsigned long)
 Forces the current thread to sleep for usecs microseconds. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

Definition at line 138 of file qfilesystemwatcher_win_p.h.

Constructors and Destructors

◆ QWindowsFileSystemWatcherEngineThread()

QWindowsFileSystemWatcherEngineThread::QWindowsFileSystemWatcherEngineThread ( )

Definition at line 306 of file qfilesystemwatcher_win.cpp.

307  : msg(0)
308 {
309  if (HANDLE h = CreateEvent(0, false, false, 0)) {
310  handles.reserve(MAXIMUM_WAIT_OBJECTS);
311  handles.append(h);
312  }
313  moveToThread(this);
314 }
void append(const T &t)
Inserts value at the end of the vector.
Definition: qvector.h:573
void moveToThread(QThread *thread)
Changes the thread affinity for this object and its children.
Definition: qobject.cpp:1458
void * HANDLE
Definition: qnamespace.h:1671
void reserve(int size)
Attempts to allocate memory for at least size elements.
Definition: qvector.h:339

◆ ~QWindowsFileSystemWatcherEngineThread()

QWindowsFileSystemWatcherEngineThread::~QWindowsFileSystemWatcherEngineThread ( )

Definition at line 317 of file qfilesystemwatcher_win.cpp.

318 {
319  CloseHandle(handles.at(0));
320  handles[0] = INVALID_HANDLE_VALUE;
321 
322  foreach (HANDLE h, handles) {
323  if (h == INVALID_HANDLE_VALUE)
324  continue;
325  FindCloseChangeNotification(h);
326  }
327 }
void * HANDLE
Definition: qnamespace.h:1671
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350

Functions

◆ directoryChanged

void QWindowsFileSystemWatcherEngineThread::directoryChanged ( const QString path,
bool  removed 
)
signal

Referenced by run().

◆ fileChanged

void QWindowsFileSystemWatcherEngineThread::fileChanged ( const QString path,
bool  removed 
)
signal

Referenced by run().

◆ run()

void QWindowsFileSystemWatcherEngineThread::run ( void  )
virtual

The starting point for the thread.

After calling start(), the newly created thread calls this function. The default implementation simply calls exec().

You can reimplement this function to facilitate advanced thread management. Returning from this method will end the execution of the thread.

See also
start() wait()

Reimplemented from QThread.

Definition at line 329 of file qfilesystemwatcher_win.cpp.

330 {
331  QMutexLocker locker(&mutex);
332  forever {
333  QVector<HANDLE> handlesCopy = handles;
334  locker.unlock();
335  // qDebug() << "QWindowsFileSystemWatcherThread"<<this<<"waiting on" << handlesCopy.count() << "handles";
336  DWORD r = WaitForMultipleObjects(handlesCopy.count(), handlesCopy.constData(), false, INFINITE);
337  locker.relock();
338  do {
339  if (r == WAIT_OBJECT_0) {
340  int m = msg;
341  msg = 0;
342  if (m == 'q') {
343  // qDebug() << "thread"<<this<<"told to quit";
344  return;
345  }
346  if (m != '@') {
347  qDebug("QWindowsFileSystemWatcherEngine: unknown message '%c' send to thread", char(m));
348  }
349  break;
350  } else if (r > WAIT_OBJECT_0 && r < WAIT_OBJECT_0 + uint(handlesCopy.count())) {
351  int at = r - WAIT_OBJECT_0;
352  Q_ASSERT(at < handlesCopy.count());
353  HANDLE handle = handlesCopy.at(at);
354 
355  // When removing a path, FindCloseChangeNotification might actually fire a notification
356  // for some reason, so we must check if the handle exist in the handles vector
357  if (handles.contains(handle)) {
358  // qDebug()<<"thread"<<this<<"Acknowledged handle:"<<at<<handle;
359  if (!FindNextChangeNotification(handle)) {
360  qErrnoWarning("QFileSystemWatcher: FindNextChangeNotification failed!!");
361  }
362 
364  QMutableHashIterator<QString, QWindowsFileSystemWatcherEngine::PathInfo> it(h);
365  while (it.hasNext()) {
367  QString absolutePath = x.value().absolutePath;
368  QFileInfo fileInfo(x.value().path);
369  // qDebug() << "checking" << x.key();
370  if (!fileInfo.exists()) {
371  // qDebug() << x.key() << "removed!";
372  if (x.value().isDir)
373  emit directoryChanged(x.value().path, true);
374  else
375  emit fileChanged(x.value().path, true);
376  h.erase(x);
377 
378  // close the notification handle if the directory has been removed
379  if (h.isEmpty()) {
380  // qDebug() << "Thread closing handle" << handle;
381  FindCloseChangeNotification(handle); // This one might generate a notification
382 
383  int indexOfHandle = handles.indexOf(handle);
384  Q_ASSERT(indexOfHandle != -1);
385  handles.remove(indexOfHandle);
386 
387  handleForDir.remove(absolutePath);
388  // h is now invalid
389  }
390  } else if (x.value().isDir) {
391  // qDebug() << x.key() << "directory changed!";
392  emit directoryChanged(x.value().path, false);
393  x.value() = fileInfo;
394  } else if (x.value() != fileInfo) {
395  // qDebug() << x.key() << "file changed!";
396  emit fileChanged(x.value().path, false);
397  x.value() = fileInfo;
398  }
399  }
400  }
401  } else {
402  // qErrnoWarning("QFileSystemWatcher: error while waiting for change notification");
403  break; // avoid endless loop
404  }
405  handlesCopy = handles;
406  r = WaitForMultipleObjects(handlesCopy.count(), handlesCopy.constData(), false, 0);
407  } while (r != WAIT_TIMEOUT);
408  }
409 }
int remove(const Key &key)
Removes all the items that have the key from the hash.
Definition: qhash.h:784
void remove(int i)
Removes the element at index position i.
Definition: qvector.h:374
#define it(className, varName)
int count(const T &t) const
Returns the number of occurrences of value in the vector.
Definition: qvector.h:742
#define at(className, varName)
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
#define WAIT_OBJECT_0
const T value(const Key &key) const
Returns the value associated with the key.
Definition: qhash.h:606
QHash< QString, QWindowsFileSystemWatcherEngine::Handle > handleForDir
Q_CORE_EXPORT void qDebug(const char *,...)
#define emit
Definition: qobjectdefs.h:76
bool isEmpty() const
Returns true if the hash contains no items; otherwise returns false.
Definition: qhash.h:297
unsigned int uint
Definition: qglobal.h:996
void * HANDLE
Definition: qnamespace.h:1671
int indexOf(const T &t, int from=0) const
Returns the index position of the first occurrence of value in the vector, searching forward from ind...
Definition: qvector.h:698
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350
void fileChanged(const QString &path, bool removed)
The QMutexLocker class is a convenience class that simplifies locking and unlocking mutexes...
Definition: qmutex.h:101
QHash< HANDLE, QHash< QString, QWindowsFileSystemWatcherEngine::PathInfo > > pathInfoForHandle
bool contains(const T &t) const
Returns true if the vector contains an occurrence of value; otherwise returns false.
Definition: qvector.h:731
void directoryChanged(const QString &path, bool removed)
const T * constData() const
Returns a const pointer to the data stored in the vector.
Definition: qvector.h:154
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
iterator erase(iterator it)
Removes the (key, value) pair associated with the iterator pos from the hash, and returns an iterator...
Definition: qhash.h:827
void qErrnoWarning(const char *msg,...)
Definition: qglobal.cpp:2954
#define forever
This macro is provided for convenience for writing infinite loops.
Definition: qglobal.h:2452

◆ stop()

void QWindowsFileSystemWatcherEngineThread::stop ( )

Definition at line 412 of file qfilesystemwatcher_win.cpp.

Referenced by QWindowsFileSystemWatcherEngine::removePaths(), QWindowsFileSystemWatcherEngine::stop(), and QWindowsFileSystemWatcherEngine::~QWindowsFileSystemWatcherEngine().

413 {
414  msg = 'q';
415  SetEvent(handles.at(0));
416 }
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350

◆ wakeup()

void QWindowsFileSystemWatcherEngineThread::wakeup ( )

Definition at line 418 of file qfilesystemwatcher_win.cpp.

Referenced by QWindowsFileSystemWatcherEngine::addPaths().

419 {
420  msg = '@';
421  SetEvent(handles.at(0));
422 }
const T & at(int i) const
Returns the item at index position i in the vector.
Definition: qvector.h:350

Properties

◆ handleForDir

QHash<QString, QWindowsFileSystemWatcherEngine::Handle> QWindowsFileSystemWatcherEngineThread::handleForDir

◆ handles

QVector<HANDLE> QWindowsFileSystemWatcherEngineThread::handles

◆ msg

int QWindowsFileSystemWatcherEngineThread::msg

◆ mutex

QMutex QWindowsFileSystemWatcherEngineThread::mutex

◆ pathInfoForHandle

QHash<HANDLE, QHash<QString, QWindowsFileSystemWatcherEngine::PathInfo> > QWindowsFileSystemWatcherEngineThread::pathInfoForHandle

The documentation for this class was generated from the following files: