IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)

QThreadPool Class

The https:// class manages a collection of QThreads.

All functions in this class are thread-safe.

Article lu   fois.

L'auteur

Liens sociaux

Viadeo Twitter Facebook Share on Google+   

QThreadPool Class▲

  • Header: QThreadPool

  • CMake:

    find_package(Qt6 REQUIRED COMPONENTS Core)

    target_link_libraries(mytarget PRIVATE Qt6::Core)

  • qmake: QT += core

  • Inherits: https://

  • Group: QThreadPool is part of thread

Detailed Description▲

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

To use one of the https:// threads, subclass https:// and implement the run() virtual function. Then create an object of that class and pass it to https://().

 
Sélectionnez
class HelloWorldTask : public QRunnable
{
    void run() override
    {
        qDebug() << "Hello world from thread" << QThread::currentThread();
    }
};

HelloWorldTask *hello = new HelloWorldTask();
// QThreadPool takes ownership and deletes 'hello' automatically
QThreadPool::globalInstance()->start(hello);

https:// deletes the https:// automatically by default. Use https://() to change the auto-deletion flag.

https:// supports executing the same https:// more than once by calling https://(this) from within https://(). If autoDelete is enabled the https:// will be deleted when the last thread exits the run function. Calling https://() multiple times with the same https:// 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 https://(). Setting a negative expiry timeout disables the expiry mechanism.

Call https://() to query the maximum number of threads to be used. If needed, you can change the limit with https://(). The default https://() is https://(). The https://() function returns the number of threads currently doing work.

The https://() function reserves a thread for external use. Use https://() 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 https://.

Note that https:// is a low-level class for managing threads, see the Qt Concurrent module for higher level alternatives.

See Also▲

See also https://

Property Documentation▲

 

[read-only] activeThreadCount : const int▲

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

It is possible for this function to return a value that is greater than https://(). See https://() for more details.

Access functions:

  • int activeThreadCount() const

See Also▲

See also https://(), https://()

expiryTimeout : int▲

This property holds the thread expiry timeout value in milliseconds.

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 https://().

Access functions:

  • int expiryTimeout() const

  • void setExpiryTimeout(int expiryTimeout)

maxThreadCount : int▲

This property holds the maximum number of threads used by the thread pool. This property will default to the value of https://() at the moment the https:// object is created.

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

The default maxThreadCount is https://().

Access functions:

  • int maxThreadCount() const

  • void setMaxThreadCount(int maxThreadCount)

[since 5.10] stackSize : uint▲

This property holds the stack size for the thread pool worker threads.

The value of the property is only used when the thread pool creates new threads. Changing it has no effect for already created or running threads.

The default value is 0, which makes https:// use the operating system default stack size.

This property was introduced in Qt 5.10.

Access functions:

  • stackSize() const

  • void setStackSize( stackSize)

[since 6.2] threadPriority : QThread::Priority▲

This property holds the thread priority for new worker threads.

The value of the property is only used when the thread pool starts new threads. Changing it has no effect for already running threads.

The default value is https://, which makes https:// use the same priority as the one the https:// object lives in.

This property was introduced in Qt 6.2.

Access functions:

  • threadPriority() const

  • void setThreadPriority( priority)

See Also▲

See also https://

Member Function Documentation▲

 

QThreadPool::QThreadPool(QObject *parent = nullptr)▲

Constructs a thread pool with the given parent.

[virtual] QThreadPool::~QThreadPool()▲

Destroys the https://. This function will block until all runnables have been completed.

[since 5.2] void QThreadPool::clear()▲

Removes the runnables that are not yet started from the queue. The runnables for which https://() returns true are deleted.

This function was introduced in Qt 5.2.

See Also▲

See also https://()

[since 6.0] bool QThreadPool::contains(const QThread *thread) const▲

Returns true if thread is a thread managed by this thread pool.

This function was introduced in Qt 6.0.

[static] QThreadPool *QThreadPool::globalInstance()▲

Returns the global https:// instance.

void QThreadPool::releaseThread()▲

Releases a thread previously reserved by a call to https://().

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

See Also▲

See also https://()

void QThreadPool::reserveThread()▲

Reserves one thread, disregarding https://() and https://().

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

Even if reserving https://() threads or more, the thread pool will still allow a minimum of one thread.

This function will increase the reported number of active threads. This means that by using this function, it is possible for https://() to return a value greater than https://() .

See Also▲

See also https://()

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 https://(). 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 https://() returns true, and the runnable will be deleted automatically by the thread pool after the https://() returns. If https://() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this functions results in undefined behavior.

[since 5.15] void QThreadPool::start(std::function<void ()> functionToRun, int priority = 0)▲

This is an overloaded function.

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

This function was introduced in Qt 5.15.

[since 6.3] void QThreadPool::startOnReservedThread(QRunnable *runnable)▲

Releases a thread previously reserved with https://() and uses it to run runnable.

Note that the thread pool takes ownership of the runnable if https://() returns true, and the runnable will be deleted automatically by the thread pool after the https://() returns. If https://() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this functions results in undefined behavior.

Calling this when no threads are reserved results in undefined behavior.

This function was introduced in Qt 6.3.

See Also▲

See also https://(), https://()

[since 6.3] void QThreadPool::startOnReservedThread(std::function<void ()> functionToRun)▲

This is an overloaded function.

Releases a thread previously reserved with https://() and uses it to run functionToRun.

This function was introduced in Qt 6.3.

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. Otherwise, runnable is run immediately using one available thread and this function returns true.

Note that on success the thread pool takes ownership of the runnable if https://() returns true, and the runnable will be deleted automatically by the thread pool after the https://() returns. If https://() returns false, ownership of runnable remains with the caller. Note that changing the auto-deletion on runnable after calling this function results in undefined behavior.

[since 5.15] bool QThreadPool::tryStart(std::function<void ()> functionToRun)▲

This is an overloaded function.

Attempts to reserve a thread to run functionToRun.

If no threads are available at the time of calling, then this function does nothing and returns false. Otherwise, functionToRun is run immediately using one available thread and this function returns true.

This function was introduced in Qt 5.15.

[since 5.9] 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.

If runnable->autoDelete() == true, this function may remove the wrong runnable. This is known as the https://: 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.

This function was introduced in Qt 5.9.

See Also▲

See also https://(), https://()

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. If msecs is -1 (the default), the timeout is ignored (waits for the last thread to exit).

Vous avez aimé ce tutoriel ? Alors partagez-le en cliquant sur les boutons suivants : Viadeo Twitter Facebook Share on Google+   

Ce document est disponible sous la licence https:// telle que publiée par la Free Software Foundation.