MythTV  master
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes | List of all members
TaskQueue Class Reference

#include <taskqueue.h>

Inheritance diagram for TaskQueue:
Inheritance graph
[legend]
Collaboration diagram for TaskQueue:
Collaboration graph
[legend]

Public Member Functions

virtual ~TaskQueue ()
 
void RequestTerminate ()
 
void Clear ()
 
void AddTask (long msec, Task *pTask)
 
void AddTask (TaskTime tt, Task *pTask)
 
void AddTask (Task *pTask)
 
TaskGetNextExpiredTask (TaskTime tt, long nWithinMilliSecs=50)
 
- Public Member Functions inherited from MThread
 MThread (const QString &objectName)
 Standard constructor. More...
 
 MThread (const QString &objectName, QRunnable *runnable)
 Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...
 
virtual ~MThread ()
 
void RunProlog (void)
 Sets up a thread, call this if you reimplement run(). More...
 
void RunEpilog (void)
 Cleans up a thread's resources, call this if you reimplement run(). More...
 
QThread * qthread (void)
 Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...
 
void setObjectName (const QString &name)
 
QString objectName (void) const
 
void setPriority (QThread::Priority priority)
 
QThread::Priority priority (void) const
 
bool isFinished (void) const
 
bool isRunning (void) const
 
void setStackSize (uint stackSize)
 
uint stackSize (void) const
 
void exit (int retcode=0)
 Use this to exit from the thread if you are using a Qt event loop. More...
 
void start (QThread::Priority=QThread::InheritPriority)
 Tell MThread to start running the thread in the near future. More...
 
void terminate (void)
 Kill a thread unsafely. More...
 
void quit (void)
 calls exit(0) More...
 
bool wait (unsigned long time=ULONG_MAX)
 Wait for the MThread to exit, with a maximum timeout. More...
 

Static Public Member Functions

static TaskQueueInstance ()
 
static void Shutdown ()
 
- Static Public Member Functions inherited from MThread
static void ThreadSetup (const QString &)
 This is to be called on startup in those few threads that haven't been ported to MThread. More...
 
static void ThreadCleanup (void)
 This is to be called on exit in those few threads that haven't been ported to MThread. More...
 
static void Cleanup (void)
 This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...
 
static void GetAllThreadNames (QStringList &list)
 
static void GetAllRunningThreadNames (QStringList &list)
 

Protected Member Functions

bool IsTermRequested ()
 
void run () override
 Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...
 
- Protected Member Functions inherited from MThread
int exec (void)
 Enters the qt event loop. call exit or quit to exit thread. More...
 

Protected Attributes

TaskMap m_mapTasks
 
QMutex m_mutex
 
bool m_bTermRequested {false}
 
- Protected Attributes inherited from MThread
MThreadInternalm_thread {nullptr}
 
QRunnable * m_runnable {nullptr}
 
bool m_prolog_executed {true}
 
bool m_epilog_executed {true}
 

Private Member Functions

 TaskQueue ()
 

Static Private Attributes

static TaskQueueg_pTaskQueue = nullptr
 

Additional Inherited Members

- Static Public Attributes inherited from MThread
static const int kDefaultStartTimeout
 
- Static Protected Member Functions inherited from MThread
static void setTerminationEnabled (bool enabled=true)
 
static void sleep (unsigned long time)
 
static void msleep (unsigned long time)
 
static void usleep (unsigned long time)
 

Detailed Description

Definition at line 82 of file taskqueue.h.

Constructor & Destructor Documentation

◆ TaskQueue()

TaskQueue::TaskQueue ( )
private

Definition at line 79 of file taskqueue.cpp.

Referenced by Instance().

◆ ~TaskQueue()

TaskQueue::~TaskQueue ( )
virtual

Definition at line 92 of file taskqueue.cpp.

Member Function Documentation

◆ IsTermRequested()

bool TaskQueue::IsTermRequested ( )
protected

◆ run()

void TaskQueue::run ( void  )
overrideprotectedvirtual

Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.

Note
If you override this method you must call RunProlog before you do any work and RunEpilog before you exit the run method.

Reimplemented from MThread.

Definition at line 110 of file taskqueue.cpp.

◆ Instance()

TaskQueue * TaskQueue::Instance ( )
static

◆ Shutdown()

void TaskQueue::Shutdown ( void  )
static

Definition at line 68 of file taskqueue.cpp.

Referenced by MythContext::~MythContext().

◆ RequestTerminate()

void TaskQueue::RequestTerminate ( void  )

Definition at line 101 of file taskqueue.cpp.

Referenced by cleanup().

◆ Clear()

void TaskQueue::Clear ( void  )

Definition at line 152 of file taskqueue.cpp.

Referenced by ~TaskQueue().

◆ AddTask() [1/3]

void TaskQueue::AddTask ( long  msec,
Task pTask 
)

◆ AddTask() [2/3]

void TaskQueue::AddTask ( TaskTime  tt,
Task pTask 
)

Definition at line 187 of file taskqueue.cpp.

◆ AddTask() [3/3]

void TaskQueue::AddTask ( Task pTask)

Definition at line 202 of file taskqueue.cpp.

◆ GetNextExpiredTask()

Task * TaskQueue::GetNextExpiredTask ( TaskTime  tt,
long  nWithinMilliSecs = 50 
)

Definition at line 218 of file taskqueue.cpp.

Referenced by run().

Member Data Documentation

◆ g_pTaskQueue

TaskQueue * TaskQueue::g_pTaskQueue = nullptr
staticprivate

Definition at line 87 of file taskqueue.h.

Referenced by Instance(), and Shutdown().

◆ m_mapTasks

TaskMap TaskQueue::m_mapTasks
protected

Definition at line 91 of file taskqueue.h.

Referenced by AddTask(), Clear(), and GetNextExpiredTask().

◆ m_mutex

QMutex TaskQueue::m_mutex
protected

Definition at line 92 of file taskqueue.h.

Referenced by AddTask(), Clear(), and GetNextExpiredTask().

◆ m_bTermRequested

bool TaskQueue::m_bTermRequested {false}
protected

Definition at line 93 of file taskqueue.h.

Referenced by RequestTerminate(), run(), and ~TaskQueue().


The documentation for this class was generated from the following files: