MythTV  master
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
JobQueue Class Reference

#include <jobqueue.h>

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

Classes

struct  JobThreadStruct
 

Public Member Functions

 JobQueue (bool master)
 
 ~JobQueue (void) override
 
void customEvent (QEvent *e) override
 
int GetRunningJobID (uint chanid, const QDateTime &recstartts)
 

Static Public Member Functions

static bool QueueRecordingJobs (const RecordingInfo &recinfo, int jobTypes=JOB_NONE)
 
static bool QueueJob (int jobType, uint chanid, const QDateTime &recstartts, const QString &args="", const QString &comment="", QString host="", int flags=0, int status=JOB_QUEUED, QDateTime schedruntime=QDateTime())
 
static bool QueueJobs (int jobTypes, uint chanid, const QDateTime &recstartts, const QString &args="", const QString &comment="", const QString &host="")
 
static int GetJobID (int jobType, uint chanid, const QDateTime &recstartts)
 
static bool GetJobInfoFromID (int jobID, int &jobType, uint &chanid, QDateTime &recstartts)
 
static bool GetJobInfoFromID (int jobID, int &jobType, uint &chanid, QString &recstartts)
 
static int GetJobTypeFromName (const QString &name)
 
static bool ChangeJobCmds (int jobID, int newCmds)
 
static bool ChangeJobCmds (int jobType, uint chanid, const QDateTime &recstartts, int newCmds)
 
static bool ChangeJobFlags (int jobID, int newFlags)
 
static bool ChangeJobStatus (int jobID, int newStatus, const QString &comment="")
 
static bool ChangeJobHost (int jobID, const QString &newHostname)
 
static bool ChangeJobComment (int jobID, const QString &comment="")
 
static bool ChangeJobArgs (int jobID, const QString &args="")
 
static bool IsJobQueuedOrRunning (int jobType, uint chanid, const QDateTime &recstartts)
 
static bool IsJobRunning (int jobType, uint chanid, const QDateTime &recstartts)
 
static bool IsJobRunning (int jobType, const ProgramInfo &pginfo)
 
static bool IsJobQueued (int jobType, uint chanid, const QDateTime &recstartts)
 
static bool IsJobStatusQueued (int status)
 
static bool IsJobStatusRunning (int status)
 
static bool PauseJob (int jobID)
 
static bool ResumeJob (int jobID)
 
static bool RestartJob (int jobID)
 
static bool StopJob (int jobID)
 
static bool DeleteJob (int jobID)
 
static bool SafeDeleteJob (int jobID, int jobType, int chanid, const QDateTime &recstartts)
 
static enum JobCmds GetJobCmd (int jobID)
 
static enum JobFlags GetJobFlags (int jobID)
 
static enum JobStatus GetJobStatus (int jobID)
 
static enum JobStatus GetJobStatus (int jobType, uint chanid, const QDateTime &recstartts)
 
static QString GetJobArgs (int jobID)
 
static int UserJobTypeToIndex (int JobType)
 
static bool DeleteAllJobs (uint chanid, const QDateTime &recstartts)
 
static void ClearJobMask (int &mask)
 
static bool JobIsInMask (int job, int mask)
 
static bool JobIsNotInMask (int job, int mask)
 
static void AddJobsToMask (int jobs, int &mask)
 
static void RemoveJobsFromMask (int jobs, int &mask)
 
static QString JobText (int jobType)
 
static QString StatusText (int status)
 
static bool HasRunningOrPendingJobs (std::chrono::minutes startingWithinMins=0min)
 
static int GetJobsInQueue (QMap< int, JobQueueEntry > &jobs, int findJobs=JOB_LIST_NOT_DONE)
 
static void RecoverQueue (bool justOld=false)
 
static void RecoverOldJobsInQueue ()
 
static void CleanupOldJobsInQueue ()
 
static bool InJobRunWindow (QDateTime jobstarttsRaw)
 

Private Member Functions

void run (void) override
 
void ProcessQueue (void)
 
void ProcessJob (const JobQueueEntry &job)
 
bool AllowedToRun (const JobQueueEntry &job)
 
void StartChildJob (void *(*ChildThreadRoutine)(void *), int jobID)
 
void RemoveRunningJob (int id)
 
void DoTranscodeThread (int jobID)
 
void DoMetadataLookupThread (int jobID)
 
void DoFlagCommercialsThread (int jobID)
 
void DoUserJobThread (int jobID)
 

Static Private Member Functions

static bool InJobRunWindow (std::chrono::minutes orStartsWithinMins=0min)
 
static QString GetJobDescription (int jobType)
 
static QString GetJobCommand (int id, int jobType, ProgramInfo *tmpInfo)
 
static QString PrettyPrint (off_t bytes)
 
static void * TranscodeThread (void *param)
 
static void * MetadataLookupThread (void *param)
 
static void * FlagCommercialsThread (void *param)
 
static void * UserJobThread (void *param)
 

Private Attributes

QString m_hostname
 
int m_jobsRunning {0}
 
int m_jobQueueCPU {0}
 
ProgramInfom_pginfo {nullptr}
 
QRecursiveMutex * m_runningJobsLock {nullptr}
 
QMap< int, RunningJobInfom_runningJobs
 
bool m_isMaster
 
MThreadm_queueThread {nullptr}
 
QWaitCondition m_queueThreadCond
 
QMutex m_queueThreadCondLock
 
bool m_processQueue {false}
 

Friends

class QueueProcessorThread
 

Detailed Description

Definition at line 126 of file jobqueue.h.

Constructor & Destructor Documentation

◆ JobQueue()

JobQueue::JobQueue ( bool  master)
explicit

Definition at line 47 of file jobqueue.cpp.

◆ ~JobQueue()

JobQueue::~JobQueue ( void  )
override

Definition at line 72 of file jobqueue.cpp.

Member Function Documentation

◆ customEvent()

void JobQueue::customEvent ( QEvent *  e)
override

Definition at line 88 of file jobqueue.cpp.

◆ QueueRecordingJobs()

bool JobQueue::QueueRecordingJobs ( const RecordingInfo recinfo,
int  jobTypes = JOB_NONE 
)
static

Definition at line 500 of file jobqueue.cpp.

Referenced by TVRec::FinishedRecording().

◆ QueueJob()

bool JobQueue::QueueJob ( int  jobType,
uint  chanid,
const QDateTime &  recstartts,
const QString &  args = "",
const QString &  comment = "",
QString  host = "",
int  flags = 0,
int  status = JOB_QUEUED,
QDateTime  schedruntime = QDateTime() 
)
static

◆ QueueJobs()

bool JobQueue::QueueJobs ( int  jobTypes,
uint  chanid,
const QDateTime &  recstartts,
const QString &  args = "",
const QString &  comment = "",
const QString &  host = "" 
)
static

Definition at line 606 of file jobqueue.cpp.

Referenced by QueueRecordingJobs().

◆ GetJobID()

int JobQueue::GetJobID ( int  jobType,
uint  chanid,
const QDateTime &  recstartts 
)
static

◆ GetJobInfoFromID() [1/2]

bool JobQueue::GetJobInfoFromID ( int  jobID,
int &  jobType,
uint chanid,
QDateTime &  recstartts 
)
static

Definition at line 673 of file jobqueue.cpp.

Referenced by GetJobInfoFromID(), and main().

◆ GetJobInfoFromID() [2/2]

bool JobQueue::GetJobInfoFromID ( int  jobID,
int &  jobType,
uint chanid,
QString &  recstartts 
)
static

Definition at line 698 of file jobqueue.cpp.

◆ GetJobTypeFromName()

int JobQueue::GetJobTypeFromName ( const QString &  name)
static

Definition at line 712 of file jobqueue.cpp.

Referenced by Dvr::ManageJobQueue(), and V2Dvr::ManageJobQueue().

◆ ChangeJobCmds() [1/2]

bool JobQueue::ChangeJobCmds ( int  jobID,
int  newCmds 
)
static

◆ ChangeJobCmds() [2/2]

bool JobQueue::ChangeJobCmds ( int  jobType,
uint  chanid,
const QDateTime &  recstartts,
int  newCmds 
)
static

Definition at line 948 of file jobqueue.cpp.

◆ ChangeJobFlags()

bool JobQueue::ChangeJobFlags ( int  jobID,
int  newFlags 
)
static

Definition at line 970 of file jobqueue.cpp.

◆ ChangeJobStatus()

bool JobQueue::ChangeJobStatus ( int  jobID,
int  newStatus,
const QString &  comment = "" 
)
static

◆ ChangeJobHost()

bool JobQueue::ChangeJobHost ( int  jobID,
const QString &  newHostname 
)
static

Definition at line 1400 of file jobqueue.cpp.

Referenced by ProcessQueue(), and RecoverQueue().

◆ ChangeJobComment()

bool JobQueue::ChangeJobComment ( int  jobID,
const QString &  comment = "" 
)
static

◆ ChangeJobArgs()

bool JobQueue::ChangeJobArgs ( int  jobID,
const QString &  args = "" 
)
static

Definition at line 1043 of file jobqueue.cpp.

Referenced by main().

◆ IsJobQueuedOrRunning()

bool JobQueue::IsJobQueuedOrRunning ( int  jobType,
uint  chanid,
const QDateTime &  recstartts 
)
static

◆ GetRunningJobID()

int JobQueue::GetRunningJobID ( uint  chanid,
const QDateTime &  recstartts 
)

Definition at line 1065 of file jobqueue.cpp.

Referenced by ProcessQueue().

◆ IsJobRunning() [1/2]

bool JobQueue::IsJobRunning ( int  jobType,
uint  chanid,
const QDateTime &  recstartts 
)
static

◆ IsJobRunning() [2/2]

bool JobQueue::IsJobRunning ( int  jobType,
const ProgramInfo pginfo 
)
static

Definition at line 1100 of file jobqueue.cpp.

◆ IsJobQueued()

bool JobQueue::IsJobQueued ( int  jobType,
uint  chanid,
const QDateTime &  recstartts 
)
static

Definition at line 1114 of file jobqueue.cpp.

◆ IsJobStatusQueued()

bool JobQueue::IsJobStatusQueued ( int  status)
static

Definition at line 1083 of file jobqueue.cpp.

Referenced by IsJobQueued(), and PlaybackBox::PbbJobQueue::IsJobQueued().

◆ IsJobStatusRunning()

bool JobQueue::IsJobStatusRunning ( int  status)
static

Definition at line 1088 of file jobqueue.cpp.

Referenced by IsJobRunning(), and PlaybackBox::PbbJobQueue::IsJobRunning().

◆ PauseJob()

bool JobQueue::PauseJob ( int  jobID)
static

Definition at line 723 of file jobqueue.cpp.

Referenced by StatusBox::customEvent().

◆ ResumeJob()

bool JobQueue::ResumeJob ( int  jobID)
static

Definition at line 732 of file jobqueue.cpp.

Referenced by StatusBox::customEvent().

◆ RestartJob()

bool JobQueue::RestartJob ( int  jobID)
static

Definition at line 741 of file jobqueue.cpp.

◆ StopJob()

bool JobQueue::StopJob ( int  jobID)
static

Definition at line 750 of file jobqueue.cpp.

Referenced by StatusBox::customEvent().

◆ DeleteJob()

bool JobQueue::DeleteJob ( int  jobID)
static

Definition at line 880 of file jobqueue.cpp.

Referenced by StatusBox::customEvent(), and QueueJob().

◆ SafeDeleteJob()

bool JobQueue::SafeDeleteJob ( int  jobID,
int  jobType,
int  chanid,
const QDateTime &  recstartts 
)
static

Definition at line 885 of file jobqueue.cpp.

Referenced by DeleteJob(), Dvr::ManageJobQueue(), and V2Dvr::ManageJobQueue().

◆ GetJobCmd()

enum JobCmds JobQueue::GetJobCmd ( int  jobID)
static

◆ GetJobFlags()

enum JobFlags JobQueue::GetJobFlags ( int  jobID)
static

Definition at line 1506 of file jobqueue.cpp.

Referenced by DoTranscodeThread(), and main().

◆ GetJobStatus() [1/2]

enum JobStatus JobQueue::GetJobStatus ( int  jobID)
static

◆ GetJobStatus() [2/2]

enum JobStatus JobQueue::GetJobStatus ( int  jobType,
uint  chanid,
const QDateTime &  recstartts 
)
static

Definition at line 1547 of file jobqueue.cpp.

◆ GetJobArgs()

QString JobQueue::GetJobArgs ( int  jobID)
static

Definition at line 1485 of file jobqueue.cpp.

Referenced by CompleteJob().

◆ UserJobTypeToIndex()

int JobQueue::UserJobTypeToIndex ( int  JobType)
static

◆ DeleteAllJobs()

bool JobQueue::DeleteAllJobs ( uint  chanid,
const QDateTime &  recstartts 
)
static

Definition at line 759 of file jobqueue.cpp.

Referenced by MainServer::DoDeleteThread().

◆ ClearJobMask()

static void JobQueue::ClearJobMask ( int &  mask)
inlinestatic

Definition at line 195 of file jobqueue.h.

◆ JobIsInMask()

static bool JobQueue::JobIsInMask ( int  job,
int  mask 
)
inlinestatic

Definition at line 196 of file jobqueue.h.

Referenced by init_jobs().

◆ JobIsNotInMask()

static bool JobQueue::JobIsNotInMask ( int  job,
int  mask 
)
inlinestatic

Definition at line 197 of file jobqueue.h.

Referenced by init_jobs().

◆ AddJobsToMask()

static void JobQueue::AddJobsToMask ( int  jobs,
int &  mask 
)
inlinestatic

Definition at line 199 of file jobqueue.h.

Referenced by init_jobs().

◆ RemoveJobsFromMask()

static void JobQueue::RemoveJobsFromMask ( int  jobs,
int &  mask 
)
inlinestatic

Definition at line 200 of file jobqueue.h.

Referenced by TVRec::FinishedRecording(), and init_jobs().

◆ JobText()

QString JobQueue::JobText ( int  jobType)
static

◆ StatusText()

QString JobQueue::StatusText ( int  status)
static

◆ HasRunningOrPendingJobs()

bool JobQueue::HasRunningOrPendingJobs ( std::chrono::minutes  startingWithinMins = 0min)
static

Definition at line 1229 of file jobqueue.cpp.

Referenced by getStatus(), and Scheduler::HandleIdleShutdown().

◆ GetJobsInQueue()

int JobQueue::GetJobsInQueue ( QMap< int, JobQueueEntry > &  jobs,
int  findJobs = JOB_LIST_NOT_DONE 
)
static

◆ RecoverQueue()

void JobQueue::RecoverQueue ( bool  justOld = false)
static

Definition at line 1571 of file jobqueue.cpp.

Referenced by run().

◆ RecoverOldJobsInQueue()

static void JobQueue::RecoverOldJobsInQueue ( )
inlinestatic

Definition at line 211 of file jobqueue.h.

Referenced by JobQueueRecoverTask::DoRun().

◆ CleanupOldJobsInQueue()

void JobQueue::CleanupOldJobsInQueue ( )
static

Definition at line 1634 of file jobqueue.cpp.

Referenced by CleanupTask::DoRun().

◆ InJobRunWindow() [1/2]

bool JobQueue::InJobRunWindow ( QDateTime  jobstarttsRaw)
static

◆ run()

void JobQueue::run ( void  )
overrideprivate

Definition at line 158 of file jobqueue.cpp.

◆ ProcessQueue()

void JobQueue::ProcessQueue ( void  )
private

Definition at line 173 of file jobqueue.cpp.

Referenced by run().

◆ ProcessJob()

void JobQueue::ProcessJob ( const JobQueueEntry job)
private

Definition at line 1689 of file jobqueue.cpp.

Referenced by ProcessQueue().

◆ AllowedToRun()

bool JobQueue::AllowedToRun ( const JobQueueEntry job)
private

Definition at line 1432 of file jobqueue.cpp.

Referenced by ProcessQueue().

◆ InJobRunWindow() [2/2]

bool JobQueue::InJobRunWindow ( std::chrono::minutes  orStartsWithinMins = 0min)
staticprivate

Definition at line 1150 of file jobqueue.cpp.

◆ StartChildJob()

void JobQueue::StartChildJob ( void *(*)(void *)  ChildThreadRoutine,
int  jobID 
)
private

Definition at line 1777 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ GetJobDescription()

QString JobQueue::GetJobDescription ( int  jobType)
staticprivate

Definition at line 1791 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ GetJobCommand()

QString JobQueue::GetJobCommand ( int  id,
int  jobType,
ProgramInfo tmpInfo 
)
staticprivate

Definition at line 1806 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ RemoveRunningJob()

void JobQueue::RemoveRunningJob ( int  id)
private

◆ PrettyPrint()

QString JobQueue::PrettyPrint ( off_t  bytes)
staticprivate

Definition at line 1875 of file jobqueue.cpp.

Referenced by DoTranscodeThread().

◆ TranscodeThread()

void * JobQueue::TranscodeThread ( void *  param)
staticprivate

Definition at line 1908 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ DoTranscodeThread()

void JobQueue::DoTranscodeThread ( int  jobID)
private

Definition at line 1922 of file jobqueue.cpp.

Referenced by TranscodeThread().

◆ MetadataLookupThread()

void * JobQueue::MetadataLookupThread ( void *  param)
staticprivate

Definition at line 2138 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ DoMetadataLookupThread()

void JobQueue::DoMetadataLookupThread ( int  jobID)
private

Definition at line 2152 of file jobqueue.cpp.

Referenced by MetadataLookupThread().

◆ FlagCommercialsThread()

void * JobQueue::FlagCommercialsThread ( void *  param)
staticprivate

Definition at line 2258 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ DoFlagCommercialsThread()

void JobQueue::DoFlagCommercialsThread ( int  jobID)
private

Definition at line 2272 of file jobqueue.cpp.

Referenced by FlagCommercialsThread().

◆ UserJobThread()

void * JobQueue::UserJobThread ( void *  param)
staticprivate

Definition at line 2404 of file jobqueue.cpp.

Referenced by ProcessJob().

◆ DoUserJobThread()

void JobQueue::DoUserJobThread ( int  jobID)
private

Definition at line 2418 of file jobqueue.cpp.

Referenced by UserJobThread().

Friends And Related Function Documentation

◆ QueueProcessorThread

friend class QueueProcessorThread
friend

Definition at line 130 of file jobqueue.h.

Member Data Documentation

◆ m_hostname

QString JobQueue::m_hostname
private

Definition at line 253 of file jobqueue.h.

Referenced by AllowedToRun(), and ProcessQueue().

◆ m_jobsRunning

int JobQueue::m_jobsRunning {0}
private

Definition at line 255 of file jobqueue.h.

Referenced by ProcessQueue().

◆ m_jobQueueCPU

int JobQueue::m_jobQueueCPU {0}
private

Definition at line 256 of file jobqueue.h.

Referenced by DoTranscodeThread(), DoUserJobThread(), and JobQueue().

◆ m_pginfo

ProgramInfo* JobQueue::m_pginfo {nullptr}
private

Definition at line 258 of file jobqueue.h.

◆ m_runningJobsLock

QRecursiveMutex* JobQueue::m_runningJobsLock {nullptr}
private

◆ m_runningJobs

QMap<int, RunningJobInfo> JobQueue::m_runningJobs
private

◆ m_isMaster

bool JobQueue::m_isMaster
private

Definition at line 270 of file jobqueue.h.

◆ m_queueThread

MThread* JobQueue::m_queueThread {nullptr}
private

Definition at line 272 of file jobqueue.h.

Referenced by JobQueue(), and ~JobQueue().

◆ m_queueThreadCond

QWaitCondition JobQueue::m_queueThreadCond
private

Definition at line 273 of file jobqueue.h.

Referenced by ProcessQueue(), run(), and ~JobQueue().

◆ m_queueThreadCondLock

QMutex JobQueue::m_queueThreadCondLock
private

Definition at line 274 of file jobqueue.h.

Referenced by JobQueue(), ProcessQueue(), run(), and ~JobQueue().

◆ m_processQueue

bool JobQueue::m_processQueue {false}
private

Definition at line 275 of file jobqueue.h.

Referenced by JobQueue(), ProcessQueue(), and ~JobQueue().


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