Contents

ThreadWeaver::Collection Class

class ThreadWeaver::Collection

A Collection is a vector of Jobs that will be queued together. In a Collection, the order of execution of the elements is not specified. More...

Header: #include <ThreadWeaver/Collection>
CMake: find_package(KF6 REQUIRED COMPONENTS ThreadWeaver)
target_link_libraries(mytarget PRIVATE KF6::ThreadWeaver)
Inherits: ThreadWeaver::Job
Inherited By:

ThreadWeaver::Sequence

Public Functions

Collection()
Collection(ThreadWeaver::Private::Collection_Private *d)
virtual void addJob(ThreadWeaver::JobPointer)
int elementCount() const
(since 6.0) void stop()
ThreadWeaver::Collection &operator<<(ThreadWeaver::JobInterface &job)
ThreadWeaver::Collection &operator<<(ThreadWeaver::JobInterface *job)
ThreadWeaver::Collection &operator<<(const ThreadWeaver::JobPointer &job)

Reimplemented Public Functions

(since 6.0) virtual void requestAbort() override

Protected Functions

ThreadWeaver::Private::Collection_Private *d()
const ThreadWeaver::Private::Collection_Private *d() const
ThreadWeaver::JobPointer jobAt(int i)
virtual int jobListLength_locked() const

Reimplemented Protected Functions

virtual void aboutToBeDequeued_locked(ThreadWeaver::QueueAPI *api) override
virtual void aboutToBeQueued_locked(ThreadWeaver::QueueAPI *api) override
virtual void execute(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *) override
virtual void run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *thread) override

Detailed Description

It is intended that the collection is set up first and then queued. After queuing, no further jobs should be added to the collection.

Member Function Documentation

Collection::Collection()

Collection::Collection(ThreadWeaver::Private::Collection_Private *d)

[override virtual protected] void Collection::aboutToBeDequeued_locked(ThreadWeaver::QueueAPI *api)

Reimplements: JobInterface::aboutToBeDequeued_locked(ThreadWeaver::QueueAPI *api).

Overload to dequeue the collection.

[override virtual protected] void Collection::aboutToBeQueued_locked(ThreadWeaver::QueueAPI *api)

Reimplements: JobInterface::aboutToBeQueued_locked(ThreadWeaver::QueueAPI *api).

Overload to queue the collection.

[virtual] void Collection::addJob(ThreadWeaver::JobPointer)

Append a job to the collection.

To use Collection, create the Job objects first, add them to the collection, and then queue it. After the collection has been queued, no further Jobs are supposed to be added.

Note: Once the job has been added, execute wrappers can no more be set on it

[protected] ThreadWeaver::Private::Collection_Private *Collection::d()

[protected] const ThreadWeaver::Private::Collection_Private *Collection::d() const

int Collection::elementCount() const

Return the number of elements in the collection.

[override virtual protected] void Collection::execute(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *)

Reimplements: JobInterface::execute(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *).

Overload the execute method.

[protected] ThreadWeaver::JobPointer Collection::jobAt(int i)

Return a ref-erence to the job in the job list at position i.

[virtual protected] int Collection::jobListLength_locked() const

Return the number of jobs in the joblist. Assumes that the mutex is being held.

[override virtual, since 6.0] void Collection::requestAbort()

Reimplements: JobInterface::requestAbort().

Dequeue all remaining Jobs and request abortion of all running jobs

This function was introduced in 6.0.

See also Job::requestAbort().

[override virtual protected] void Collection::run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *thread)

Reimplements: JobInterface::run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *thread).

Overload run(). We have to.

[since 6.0] void Collection::stop()

Stop processing, dequeue all remaining Jobs.

This function was introduced in 6.0.

ThreadWeaver::Collection &Collection::operator<<(ThreadWeaver::JobInterface &job)

ThreadWeaver::Collection &Collection::operator<<(ThreadWeaver::JobInterface *job)

Add the job to this collection by pointer.

ThreadWeaver::Collection &Collection::operator<<(const ThreadWeaver::JobPointer &job)

Add the job to this collection.