Contents

ThreadWeaver Namespace

Header: #include <ThreadWeaver>
CMake: find_package(KF6 REQUIRED COMPONENTS ThreadWeaver)
target_link_libraries(mytarget PRIVATE KF6::ThreadWeaver)

Namespaces

namespace Private

Classes

class AbortThread
class Collection
class Dependency
class DependencyPolicy
class Exception
class IdDecorator
class JobAborted
class JobFailed
class JobInterface
class QObjectDecorator
class Queue
class QueueInterface
class QueuePolicy
class QueueStream
class ResourceRestrictionPolicy
class Sequence
class State
class Thread
class Weaver
class WeaverInterface

Types

JobPointer
QJobPointer
enum StateId { InConstruction, WorkingHard, Suspending, Suspended, ShuttingDown, …, NoOfStates }

Functions

void TWDEBUG(int severity, const char *cformat, ...)
void TWDEBUG(bool condition, int severity, const char *cformat, ...)
bool invariant()
QSharedPointer<ThreadWeaver::Collection> make_collection(Iterable iterable, FN callable)
void mutexAssertLocked(QMutex *mutex, const char *where)
void mutexAssertUnlocked(QMutex *mutex, const char *where)
void setDebugLevel(bool debug, int level)
void threadweaver_debug(int severity, const char *cformat, ...)
void threadweaver_debug(bool condition, int severity, const char *cformat, ...)

Detailed Description

Namespaces

namespace ThreadWeaver::Private

Classes

class AbortThread

class 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...

class Dependency

class DependencyPolicy

DependencyPolicy implements execution-time dependencies dependencies between Jobs. More...

class Exception

class IdDecorator

IdDecorator decorates a job without changing it's behaviour. More...

class JobAborted

class JobFailed

class JobInterface

class QObjectDecorator

class Queue

Queue implements a ThreadWeaver job queue. More...

class QueueInterface

WeaverInterface provides a common interface for weaver implementations. More...

class QueuePolicy

QueuePolicy is an interface for customizations of the queueing behaviour of jobs. More...

class QueueStream

QueueStream implements a stream based API to access ThreadWeaver queues. More...

class ResourceRestrictionPolicy

ResourceRestrictionPolicy is used to limit the number of concurrent accesses to the same resource. More...

class Sequence

A Sequence is a vector of Jobs that will be executed in a sequence. More...

class State

We use a State pattern to handle the system state in ThreadWeaver. More...

class Thread

Thread represents a worker thread in a Queue's inventory. More...

class Weaver

A Weaver manages worker threads. More...

class WeaverInterface

Type Documentation

JobPointer

ThreadWeaver::QJobPointer

enum StateId

All weaver objects maintain a state of operation which can be queried by the application. See the threadweaver documentation on how the different states are related.

ConstantValueDescription
ThreadWeaver::State::InConstruction0The object is in the state of construction and has not yet started to process jobs.
ThreadWeaver::State::WorkingHard1Jobs are being processed.
ThreadWeaver::State::Suspending2Job processing is suspended, but some jobs which where already in progress are not finished yet.
ThreadWeaver::State::Suspended3Job processing is suspended, and no jobs are being processed.
ThreadWeaver::State::ShuttingDown4The object is being destructed. Jobs might still be processed, the destructor will wait for all threads to exit and then end.
ThreadWeaver::State::Destructed5The object is being destructed, and all threads have exited. No jobs are handled anymore.
ThreadWeaver::State::NoOfStates6Not a state, but a sentinel for the number of defined states.

Function Documentation

void ThreadWeaver::TWDEBUG(int severity, const char *cformat, ...)

This method prints a text message on the screen, if debugging is enabled. Otherwise, it does nothing. The message is thread safe, therefore providing that the messages appear in the order they where issued by the different threads. All messages are suppressed when Debug is false. All messages with a lower importance (higher number) than DebugLevel will be suppressed, too. Debug level 0 messages will always be printed as long as Debug is true. We use our own debugging method, since debugging threads is a more complicated experience than debugging single threaded contexts. This might change in future in the way that debug prints its messages to another logging facility provided by the platform. Use setDebugLevel () to integrate adapt debug () to your platform.

void ThreadWeaver::TWDEBUG(bool condition, int severity, const char *cformat, ...)

Prints the message to the console if condition is true.

bool ThreadWeaver::invariant()

template <typename Iterable, typename FN> QSharedPointer<ThreadWeaver::Collection> ThreadWeaver::make_collection(Iterable iterable, FN callable)

Make a Collection that will execute specified callable (eg. Lambda) for each item in given iterable container You can use it to have a parallel map function.

void ThreadWeaver::mutexAssertLocked(QMutex *mutex, const char *where)

void ThreadWeaver::mutexAssertUnlocked(QMutex *mutex, const char *where)

void ThreadWeaver::setDebugLevel(bool debug, int level)

void ThreadWeaver::threadweaver_debug(int severity, const char *cformat, ...)

void ThreadWeaver::threadweaver_debug(bool condition, int severity, const char *cformat, ...)