Contents

ThreadWeaver::JobInterface Class

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

ThreadWeaver::IdDecorator

Public Types

enum Status { Status_NoStatus, Status_New, Status_Queued, Status_Running, Status_Success, …, Status_NumberOfStatuses }

Public Functions

virtual ~JobInterface()
virtual void aboutToBeDequeued(ThreadWeaver::QueueAPI *api) = 0
virtual void aboutToBeDequeued_locked(ThreadWeaver::QueueAPI *api) = 0
virtual void aboutToBeQueued(ThreadWeaver::QueueAPI *api) = 0
virtual void aboutToBeQueued_locked(ThreadWeaver::QueueAPI *api) = 0
virtual void assignQueuePolicy(ThreadWeaver::QueuePolicy *) = 0
virtual void blockingExecute() = 0
virtual void defaultBegin(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *thread) = 0
virtual void defaultEnd(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *thread) = 0
virtual void execute(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *) = 0
virtual ThreadWeaver::Executor *executor() const = 0
virtual bool isFinished() const = 0
virtual QMutex *mutex() const = 0
virtual int priority() const = 0
virtual QList<ThreadWeaver::QueuePolicy *> queuePolicies() const = 0
virtual void removeQueuePolicy(ThreadWeaver::QueuePolicy *) = 0
virtual void requestAbort() = 0
virtual void run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *thread) = 0
virtual ThreadWeaver::Executor *setExecutor(ThreadWeaver::Executor *executor) = 0
virtual void setStatus(ThreadWeaver::JobInterface::Status) = 0
virtual ThreadWeaver::JobInterface::Status status() const = 0
virtual bool success() const = 0
JobPointer

Detailed Description

Member Type Documentation

enum JobInterface::Status

ConstantValue
ThreadWeaver::JobInterface::Status_NoStatus0
ThreadWeaver::JobInterface::Status_New1
ThreadWeaver::JobInterface::Status_Queued2
ThreadWeaver::JobInterface::Status_Running3
ThreadWeaver::JobInterface::Status_Success4
ThreadWeaver::JobInterface::Status_Failed5
ThreadWeaver::JobInterface::Status_Aborted6
ThreadWeaver::JobInterface::Status_NumberOfStatuses7

Member Function Documentation

[virtual noexcept] JobInterface::~JobInterface()

[pure virtual] void JobInterface::aboutToBeDequeued(ThreadWeaver::QueueAPI *api)

[pure virtual] void JobInterface::aboutToBeDequeued_locked(ThreadWeaver::QueueAPI *api)

[pure virtual] void JobInterface::aboutToBeQueued(ThreadWeaver::QueueAPI *api)

[pure virtual] void JobInterface::aboutToBeQueued_locked(ThreadWeaver::QueueAPI *api)

[pure virtual] void JobInterface::assignQueuePolicy(ThreadWeaver::QueuePolicy *)

[pure virtual] void JobInterface::blockingExecute()

[pure virtual] void JobInterface::defaultBegin(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *thread)

[pure virtual] void JobInterface::defaultEnd(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *thread)

[pure virtual] void JobInterface::execute(const ThreadWeaver::JobPointer &job, ThreadWeaver::Thread *)

[pure virtual] ThreadWeaver::Executor *JobInterface::executor() const

See also setExecutor().

[pure virtual] bool JobInterface::isFinished() const

[pure virtual] QMutex *JobInterface::mutex() const

[pure virtual] int JobInterface::priority() const

[pure virtual] QList<ThreadWeaver::QueuePolicy *> JobInterface::queuePolicies() const

[pure virtual] void JobInterface::removeQueuePolicy(ThreadWeaver::QueuePolicy *)

[pure virtual] void JobInterface::requestAbort()

[pure virtual] void JobInterface::run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *thread)

[pure virtual] ThreadWeaver::Executor *JobInterface::setExecutor(ThreadWeaver::Executor *executor)

See also executor().

[pure virtual] void JobInterface::setStatus(ThreadWeaver::JobInterface::Status)

See also status().

[pure virtual] ThreadWeaver::JobInterface::Status JobInterface::status() const

See also setStatus().

[pure virtual] bool JobInterface::success() const

Related Non-Members

JobPointer