就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. Qt 5.9.9
  3. Qt Core
  4. C++ 类
  5. QThreadPool

内容

QThreadPool 类

QThreadPool class manages a collection of QThreads. 更多...

头： #include <QThreadPool>
qmake: QT += core
Since: Qt 4.4
继承： QObject

注意： 此类的所有函数 thread-safe .

特性

公共函数

QThreadPool (QObject * parent = Q_NULLPTR)
~QThreadPool ()
int activeThreadCount () const
void clear ()
int expiryTimeout () const
int maxThreadCount () const
void releaseThread ()
void reserveThread ()
void setExpiryTimeout (int expiryTimeout )
void setMaxThreadCount (int maxThreadCount )
void start (QRunnable * runnable , int priority = 0)
bool tryStart (QRunnable * runnable )
bool tryTake (QRunnable * runnable )
bool waitForDone (int msecs = -1)

静态公共成员

QThreadPool * globalInstance ()

额外继承成员

详细描述

QThreadPool class manages a collection of QThreads.

QThreadPool manages and recyles individual QThread objects to help reduce thread creation costs in programs that use threads. Each Qt application has one global QThreadPool object, which can be accessed by calling globalInstance ().

To use one of the QThreadPool threads, subclass QRunnable 和实现 run() 虚函数。然后创建该类的对象并把它传递给 QThreadPool::start (). 

class HelloWorldTask : public QRunnable
{
    void run()
    {
        qDebug() << "Hello world from thread" << QThread::currentThread();
    }
};
HelloWorldTask *hello = new HelloWorldTask();
// QThreadPool takes ownership and deletes 'hello' automatically
QThreadPool::globalInstance()->start(hello);

QThreadPool deletes the QRunnable 默认情况下是自动的。使用 QRunnable::setAutoDelete () 以改变自动删除标志。

QThreadPool supports executing the same QRunnable 多次通过调用 tryStart (this) 从 QRunnable::run ()。若 autoDelete 被启用 QRunnable 将被删除当最后一个线程退出 run 函数时。调用 start () multiple times with the same QRunnable when autoDelete is enabled creates a race condition and is not recommended.

Threads that are unused for a certain amount of time will expire. The default expiry timeout is 30000 milliseconds (30 seconds). This can be changed using setExpiryTimeout (). Setting a negative expiry timeout disables the expiry mechanism.

调用 maxThreadCount () to query the maximum number of threads to be used. If needed, you can change the limit with setMaxThreadCount (). The default maxThreadCount () 是 QThread::idealThreadCount ()。 activeThreadCount () function returns the number of threads currently doing work.

reserveThread () function reserves a thread for external use. Use releaseThread () when your are done with the thread, so that it may be reused. Essentially, these functions temporarily increase or reduce the active thread count and are useful when implementing time-consuming operations that are not visible to the QThreadPool .

注意， QThreadPool is a low-level class for managing threads, see the Qt Concurrent module for higher level alternatives.

另请参阅 QRunnable .

特性文档编制

activeThreadCount : const int

This property represents the number of active threads in the thread pool.

注意： It is possible for this function to return a value that is greater than maxThreadCount ()。见 reserveThread () 了解更多细节。

访问函数：

int activeThreadCount () const

另请参阅 reserveThread () 和 releaseThread ().

expiryTimeout : int

Threads that are unused for expiryTimeout milliseconds are considered to have expired and will exit. Such threads will be restarted as needed. The default expiryTimeout is 30000 milliseconds (30 seconds). If expiryTimeout is negative, newly created threads will not expire, e.g., they will not exit until the thread pool is destroyed.

Note that setting expiryTimeout has no effect on already running threads. Only newly created threads will use the new expiryTimeout . We recommend setting the expiryTimeout immediately after creating the thread pool, but before calling start ().

访问函数：

int expiryTimeout () const
void setExpiryTimeout (int expiryTimeout )

maxThreadCount : int

This property represents the maximum number of threads used by the thread pool.

注意： The thread pool will always use at least 1 thread, even if maxThreadCount limit is zero or negative.

默认 maxThreadCount is QThread::idealThreadCount ().

访问函数：

int maxThreadCount () const
void setMaxThreadCount (int maxThreadCount )

成员函数文档编制

QThreadPool:: QThreadPool ( QObject * parent = Q_NULLPTR)

构造线程池采用给定 parent .

QThreadPool:: ~QThreadPool ()

销毁 QThreadPool . This function will block until all runnables have been completed.

void QThreadPool:: clear ()

Removes the runnables that are not yet started from the queue. The runnables for which runnable->autoDelete() 返回 true are deleted.

该函数在 Qt 5.2 引入。

另请参阅 start ().

[static] QThreadPool *QThreadPool:: globalInstance ()

返回全局 QThreadPool 实例。

void QThreadPool:: releaseThread ()

Releases a thread previously reserved by a call to reserveThread ().

注意： Calling this function without previously reserving a thread temporarily increases maxThreadCount (). This is useful when a thread goes to sleep waiting for more work, allowing other threads to continue. Be sure to call reserveThread () when done waiting, so that the thread pool can correctly maintain the activeThreadCount ().

另请参阅 reserveThread ().

void QThreadPool:: reserveThread ()

Reserves one thread, disregarding activeThreadCount () 和 maxThreadCount ().

Once you are done with the thread, call releaseThread () to allow it to be reused.

注意： This function will always increase the number of active threads. This means that by using this function, it is possible for activeThreadCount () to return a value greater than maxThreadCount () .

另请参阅 releaseThread ().

void QThreadPool:: start ( QRunnable * runnable , int priority = 0)

Reserves a thread and uses it to run runnable , unless this thread will make the current thread count exceed maxThreadCount (). In that case, runnable is added to a run queue instead. The priority argument can be used to control the run queue's order of execution.

Note that the thread pool takes ownership of the runnable if runnable->autoDelete() 返回 true ，和 runnable will be deleted automatically by the thread pool after the runnable->run() returns. If runnable->autoDelete() 返回 false , ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this functions results in undefined behavior.

bool QThreadPool:: tryStart ( QRunnable * runnable )

Attempts to reserve a thread to run runnable .

If no threads are available at the time of calling, then this function does nothing and returns false 。否则， runnable is run immediately using one available thread and this function returns true .

Note that the thread pool takes ownership of the runnable if runnable->autoDelete() 返回 true ，和 runnable will be deleted automatically by the thread pool after the runnable->run() returns. If runnable->autoDelete() 返回 false , ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this function results in undefined behavior.

bool QThreadPool:: tryTake ( QRunnable * runnable )

Attempts to remove the specified runnable from the queue if it is not yet started. If the runnable had not been started, returns true , and ownership of runnable is transferred to the caller (even when runnable->autoDelete() == true ). Otherwise returns false .

注意： 若 runnable->autoDelete() == true , this function may remove the wrong runnable. This is known as the ABA problem : the original runnable may already have executed and has since been deleted. The memory is re-used for another runnable, which then gets removed instead of the intended one. For this reason, we recommend calling this function only for runnables that are not auto-deleting.

该函数在 Qt 5.9 引入。

另请参阅 start () 和 QRunnable::autoDelete ().

bool QThreadPool:: waitForDone ( int msecs = -1)

Waits up to msecs milliseconds for all threads to exit and removes all threads from the thread pool. Returns true if all threads were removed; otherwise it returns false 。若 msecs is -1 (the default), the timeout is ignored (waits for the last thread to exit).