ThreadWeaver::IdDecorator

Search for usage in LXR

ThreadWeaver::IdDecorator Class Reference

#include <iddecorator.h>

Inherits ThreadWeaver::JobInterface.

Inherited by ThreadWeaver::QObjectDecorator.

Public Member Functions

 IdDecorator (JobInterface *job, bool autoDelete=true)
 
void aboutToBeDequeued (QueueAPI *api) override
 
void aboutToBeDequeued_locked (QueueAPI *api) override
 
void aboutToBeQueued (QueueAPI *api) override
 
void aboutToBeQueued_locked (QueueAPI *api) override
 
void assignQueuePolicy (QueuePolicy *) override
 
bool autoDelete () const
 
void blockingExecute () override
 
Collectioncollection ()
 
const Collectioncollection () const
 
void execute (const JobPointer &job, Thread *) override
 
Executor * executor () const override
 
bool isFinished () const override
 
JobInterface * job ()
 
const JobInterface * job () const
 
QMutexmutex () const override
 
int priority () const override
 
QList< QueuePolicy * > queuePolicies () const override
 
void removeQueuePolicy (QueuePolicy *) override
 
void requestAbort () override
 
Sequencesequence ()
 
const Sequencesequence () const
 
void setAutoDelete (bool onOff)
 
Executor * setExecutor (Executor *executor) override
 
void setStatus (Status) override
 
Status status () const override
 
bool success () const override
 

Protected Member Functions

void defaultBegin (const JobPointer &job, Thread *thread) override
 
void defaultEnd (const JobPointer &job, Thread *thread) override
 
void run (JobPointer self, Thread *thread) override
 

Detailed Description

IdDecorator decorates a job without changing it's behaviour.

It is supposed to be used as the base class for actual decorators that do change the behaviour of jobs.

Definition at line 25 of file iddecorator.h.

Constructor & Destructor Documentation

◆ IdDecorator()

ThreadWeaver::IdDecorator::IdDecorator ( JobInterface * job,
bool autoDelete = true )
explicit

Definition at line 25 of file iddecorator.cpp.

◆ ~IdDecorator()

ThreadWeaver::IdDecorator::~IdDecorator ( )
override

Definition at line 32 of file iddecorator.cpp.

Member Function Documentation

◆ aboutToBeDequeued()

void ThreadWeaver::IdDecorator::aboutToBeDequeued ( QueueAPI * api)
override

Definition at line 101 of file iddecorator.cpp.

◆ aboutToBeDequeued_locked()

void ThreadWeaver::IdDecorator::aboutToBeDequeued_locked ( QueueAPI * api)
override

Definition at line 107 of file iddecorator.cpp.

◆ aboutToBeQueued()

void ThreadWeaver::IdDecorator::aboutToBeQueued ( QueueAPI * api)
override

Definition at line 89 of file iddecorator.cpp.

◆ aboutToBeQueued_locked()

void ThreadWeaver::IdDecorator::aboutToBeQueued_locked ( QueueAPI * api)
override

Definition at line 95 of file iddecorator.cpp.

◆ assignQueuePolicy()

void ThreadWeaver::IdDecorator::assignQueuePolicy ( QueuePolicy * policy)
override

Definition at line 77 of file iddecorator.cpp.

◆ autoDelete()

bool ThreadWeaver::IdDecorator::autoDelete ( ) const

Will the decoratee be auto-deleted?

Definition at line 186 of file iddecorator.cpp.

◆ blockingExecute()

void ThreadWeaver::IdDecorator::blockingExecute ( )
override

Definition at line 161 of file iddecorator.cpp.

◆ collection() [1/2]

Collection * ThreadWeaver::IdDecorator::collection ( )

Retrieve the decorated job as a Collection.

If the decorated Job is not a Collection, 0 is returned.

Definition at line 196 of file iddecorator.cpp.

◆ collection() [2/2]

const ThreadWeaver::Collection * ThreadWeaver::IdDecorator::collection ( ) const

Retrieve the decorated job as a Collection.

If the decorated Job is not a Collection, 0 is returned.

Definition at line 191 of file iddecorator.cpp.

◆ defaultBegin()

void ThreadWeaver::IdDecorator::defaultBegin ( const JobPointer & job,
Thread * thread )
overrideprotected

Definition at line 53 of file iddecorator.cpp.

◆ defaultEnd()

void ThreadWeaver::IdDecorator::defaultEnd ( const JobPointer & job,
Thread * thread )
overrideprotected

Definition at line 59 of file iddecorator.cpp.

◆ execute()

void ThreadWeaver::IdDecorator::execute ( const JobPointer & job,
ThreadWeaver::Thread * thread )
override

Definition at line 155 of file iddecorator.cpp.

◆ executor()

Executor * ThreadWeaver::IdDecorator::executor ( ) const
override

Definition at line 143 of file iddecorator.cpp.

◆ isFinished()

bool ThreadWeaver::IdDecorator::isFinished ( ) const
override

Definition at line 83 of file iddecorator.cpp.

◆ job() [1/2]

JobInterface * ThreadWeaver::IdDecorator::job ( )

Retrieve the decorated job.

Definition at line 172 of file iddecorator.cpp.

◆ job() [2/2]

const ThreadWeaver::JobInterface * ThreadWeaver::IdDecorator::job ( ) const

Retrieve the decorated job.

Definition at line 167 of file iddecorator.cpp.

◆ mutex()

QMutex * ThreadWeaver::IdDecorator::mutex ( ) const
override

Definition at line 41 of file iddecorator.cpp.

◆ priority()

int ThreadWeaver::IdDecorator::priority ( ) const
override

Definition at line 125 of file iddecorator.cpp.

◆ queuePolicies()

QList< QueuePolicy * > ThreadWeaver::IdDecorator::queuePolicies ( ) const
override

Definition at line 71 of file iddecorator.cpp.

◆ removeQueuePolicy()

void ThreadWeaver::IdDecorator::removeQueuePolicy ( QueuePolicy * policy)
override

Definition at line 65 of file iddecorator.cpp.

◆ requestAbort()

void ThreadWeaver::IdDecorator::requestAbort ( )
override

Definition at line 113 of file iddecorator.cpp.

◆ run()

void ThreadWeaver::IdDecorator::run ( JobPointer self,
Thread * thread )
overrideprotected

Definition at line 47 of file iddecorator.cpp.

◆ sequence() [1/2]

Sequence * ThreadWeaver::IdDecorator::sequence ( )

Retrieve the decorated job as a Sequence.

If the decorated Job is not a Sequence, 0 is returned.

Definition at line 206 of file iddecorator.cpp.

◆ sequence() [2/2]

const Sequence * ThreadWeaver::IdDecorator::sequence ( ) const

Retrieve the decorated job as a Sequence.

If the decorated Job is not a Sequence, 0 is returned.

Definition at line 201 of file iddecorator.cpp.

◆ setAutoDelete()

void ThreadWeaver::IdDecorator::setAutoDelete ( bool onOff)

Auto-delete the decoratee or not.

Definition at line 177 of file iddecorator.cpp.

◆ setExecutor()

Executor * ThreadWeaver::IdDecorator::setExecutor ( Executor * executor)
override

Definition at line 149 of file iddecorator.cpp.

◆ setStatus()

void ThreadWeaver::IdDecorator::setStatus ( JobInterface::Status status)
override

Definition at line 131 of file iddecorator.cpp.

◆ status()

JobInterface::Status ThreadWeaver::IdDecorator::status ( ) const
override

Definition at line 137 of file iddecorator.cpp.

◆ success()

bool ThreadWeaver::IdDecorator::success ( ) const
override

Definition at line 119 of file iddecorator.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:49:57 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.