This is a wrapper around QThread that does several additional things. More...

#include <mthread.h>

Inherited by AppleRemote, AudioOutputBase, AudioTestThread, CDEjectorThread, CDRipperThread, CDScannerThread, CECAdapter, ChildCountThread, DBLoggerThread, Decoder, DecoderThread, DeleteThread, DeviceReadBuffer [protected], ExpireThread, FetcherThread, FIFOThread, FileCopyThread, FileScannerThread, FilterScanThread, FirewireTableMonitorThread, GameScannerThread, GetRecordingListThread, GrabberDownloadThread, GrabberScript, HouseKeepingThread, JoystickMenuThread, KenBurnsImageLoader, LIRC, LogForwardThread, LoggerThread, LogServerThread, MetadataDownload, MetadataImageDownload, MonitorThread, MPoolThread, MythDownloadManager, MythFillDatabaseThread, MythSignalingTimer [private], MythSystemIOHandler, MythSystemIOHandler, MythSystemManager, MythSystemManager, MythSystemSignalManager, MythSystemSignalManager, NVRAudioThread, NVRWriteThread, PlaybackBoxHelper, PlaylistLoadingThread, PlaylistWorker, PreviewGenerator, PreviewGeneratorQueue, RingBuffer [protected], Scheduler, SignalMonitor [protected], SSDP, StreamHandler [protected], StreamWorker, TaskQueue, TFWSyncThread, TFWWriteThread, ThumbGenerator, TVBrowseHelper, UpdateThread, VBIThread, and VideoScannerThread.

Collaboration diagram for MThread:

[legend]

Public Member Functions
	MThread (const QString &objectName)
	Standard constructor.
	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.
virtual	~MThread ()
void	RunProlog (void)
	Sets up a thread, call this if you reimplement run().
void	RunEpilog (void)
	Cleans up a thread's resources, call this if you reimplement run().
QThread *	qthread (void)
	Returns the thread, this will always return the same pointer no matter how often you restart the thread.
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.
void	start (QThread::Priority=QThread::InheritPriority)
	Tell MThread to start running the thread in the near future.
void	terminate (void)
	Kill a thread unsafely.
void	quit (void)
	calls exit(0)
bool	wait (unsigned long time=ULONG_MAX)
	Wait for the MThread to exit, with a maximum timeout.

Static Public Member Functions
static void	ThreadSetup (const QString &)
	This is to be called on startup in those few threads that haven't been ported to MThread.
static void	ThreadCleanup (void)
	This is to be called on exit in those few threads that haven't been ported to MThread.
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.
static void	GetAllThreadNames (QStringList &list)
static void	GetAllRunningThreadNames (QStringList &list)

Static Public Attributes
static const int	kDefaultStartTimeout

Protected Member Functions
virtual void	run (void)
	Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.
int	exec (void)
	Enters the qt event loop. call exit or quit to exit thread.

Static Protected Member Functions
static void	setTerminationEnabled (bool enabled=true)
static void	sleep (unsigned long time)
static void	msleep (unsigned long time)
static void	usleep (unsigned long time)

Protected Attributes
MThreadInternal *	m_thread
QRunnable *	m_runnable
bool	m_prolog_executed
bool	m_epilog_executed

Friends
class	MThreadInternal

Detailed Description

This is a wrapper around QThread that does several additional things.

First it requires that you set the thread's name which is used for debugging.

It adds RunProlog() and RunEpilog() which are called automatically when you don't override run(), but must be called explicitly if you do. These take care of setting up logging and take care of dealing with QSqlConnections which are per-thread variables.

It also adds some sanity checking to the destructor so a thread can not be deleted while it still running.

Optionally it can be given a QRunnable to run in MThread::run() instead of calling QThread::run() (which starts an event loop.) When you override MThread::run() or use a QRunnable you are responsible for stopping the thread, MThread::exit() will not work.

Warning: Do not statically initialize MThreads. C++ itself doesn't allow you to specify the order of static initializations. See: http://www.parashift.com/c++-faq-lite/ctors.html#faq-10.15

Definition at line 44 of file mthread.h.

Constructor & Destructor Documentation

MThread::MThread ( const QString & objectName )

explicit

Standard constructor.

Definition at line 102 of file mthread.cpp.

MThread::MThread	(	const QString &	objectName,
		QRunnable *	runnable
	)

explicit

Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop.

Unlike MThreadPool, MThread will not delete a runnable with the autoDelete property set.

Definition at line 111 of file mthread.cpp.

MThread::~MThread ( )

virtual

Definition at line 120 of file mthread.cpp.

Member Function Documentation

void MThread::RunProlog ( void )

Sets up a thread, call this if you reimplement run().

Definition at line 203 of file mthread.cpp.

Referenced by PlaylistLoadingThread::run(), DeleteThread::run(), FIFOThread::run(), TFWWriteThread::run(), avfDecoder::run(), FetcherThread::run(), MonitorThread::run(), CDScannerThread::run(), FirewireTableMonitorThread::run(), MythSystemIOHandler::run(), FileScannerThread::run(), TFWSyncThread::run(), GameScannerThread::run(), CDEjectorThread::run(), MythSignalingTimer::run(), MythDownloadManager::run(), LIRC::run(), FilterScanThread::run(), GrabberScript::run(), GetRecordingListThread::run(), CdDecoder::run(), DVBStreamHandler::run(), MetadataDownload::run(), AppleRemote::run(), MythSystemManager::run(), DeviceReadBuffer::run(), FileCopyThread::run(), PreviewGenerator::run(), VideoScannerThread::run(), ThumbGenerator::run(), CDRipperThread::run(), ASIStreamHandler::run(), MetadataImageDownload::run(), MythSystemSignalManager::run(), VBIThread::run(), HDHRStreamHandler::run(), IPTVStreamHandler::run(), JoystickMenuThread::run(), Scheduler::run(), TaskQueue::run(), SSDP::run(), TVBrowseHelper::run(), SignalMonitor::run(), run(), GrabberDownloadThread::run(), AudioOutputBase::run(), LogServerThread::run(), AudioTestThread::run(), KenBurnsImageLoader::run(), RingBuffer::run(), LoggerThread::run(), LogForwardThread::run(), ChildCountThread::run(), DBLoggerThread::run(), StreamWorker::run(), and PlaylistWorker::run().

void MThread::RunEpilog ( void )

Cleans up a thread's resources, call this if you reimplement run().

Definition at line 216 of file mthread.cpp.

Referenced by PlaylistLoadingThread::run(), DeleteThread::run(), FIFOThread::run(), TFWWriteThread::run(), avfDecoder::run(), FetcherThread::run(), MonitorThread::run(), CDScannerThread::run(), FirewireTableMonitorThread::run(), MythSystemIOHandler::run(), FileScannerThread::run(), TFWSyncThread::run(), GameScannerThread::run(), CDEjectorThread::run(), MythSignalingTimer::run(), MythDownloadManager::run(), LIRC::run(), FilterScanThread::run(), GrabberScript::run(), GetRecordingListThread::run(), CdDecoder::run(), DVBStreamHandler::run(), MetadataDownload::run(), AppleRemote::run(), MythSystemManager::run(), DeviceReadBuffer::run(), FileCopyThread::run(), PreviewGenerator::run(), VideoScannerThread::run(), ThumbGenerator::run(), CDRipperThread::run(), ASIStreamHandler::run(), MetadataImageDownload::run(), MythSystemSignalManager::run(), VBIThread::run(), HDHRStreamHandler::run(), IPTVStreamHandler::run(), JoystickMenuThread::run(), Scheduler::run(), TaskQueue::run(), SSDP::run(), TVBrowseHelper::run(), SignalMonitor::run(), run(), GrabberDownloadThread::run(), AudioOutputBase::run(), LogServerThread::run(), AudioTestThread::run(), KenBurnsImageLoader::run(), RingBuffer::run(), LoggerThread::run(), LogForwardThread::run(), ChildCountThread::run(), DBLoggerThread::run(), StreamWorker::run(), and PlaylistWorker::run().

QThread * MThread::qthread ( void )

Returns the thread, this will always return the same pointer no matter how often you restart the thread.

Definition at line 241 of file mthread.cpp.

Referenced by MythSocket::ConnectToHost(), MythRAOPDevice::Create(), MythAirplayServer::Create(), MythSocket::DisconnectFromHost(), VideoScanner::doScan(), GameScanner::doScan(), UPNPScanner::Instance(), is_current_thread(), MythSocket::IsDataAvailable(), LogForwardThread::LogForwardThread(), LoggerThread::LoggerThread(), LogServerThread::LogServerThread(), MythSocket::MythSocket(), PlaybackBoxHelper::PlaybackBoxHelper(), PreviewGeneratorQueue::PreviewGeneratorQueue(), MythSocket::Read(), MythSocket::ReadStringList(), MythSocket::Reset(), Ripper::startEjectCD(), Ripper::startScanCD(), MythSocket::Write(), and MythSocket::WriteStringList().

void MThread::setObjectName ( const QString & name )

Definition at line 246 of file mthread.cpp.

Referenced by ASIStreamHandler::ASIStreamHandler(), avfDecoder::avfDecoder(), CetonStreamHandler::CetonStreamHandler(), DVBStreamHandler::DVBStreamHandler(), and HDHRStreamHandler::HDHRStreamHandler().

QString MThread::objectName ( void ) const

Definition at line 251 of file mthread.cpp.

void MThread::setPriority ( QThread::Priority priority )

Definition at line 256 of file mthread.cpp.

QThread::Priority MThread::priority ( void ) const

Definition at line 261 of file mthread.cpp.

Referenced by DVBStreamHandler::CycleFiltersByPriority().

bool MThread::isFinished ( void ) const

Definition at line 266 of file mthread.cpp.

Referenced by PlaylistContainer::cleanOutThreads(), ImportMusicDialog::startScan(), and GalleryFilterDialog::updateFilter().

bool MThread::isRunning ( void ) const

Definition at line 271 of file mthread.cpp.

Referenced by MetadataImageDownload::addDownloads(), MetadataDownload::addLookup(), MetadataImageDownload::addThumb(), MythRAOPDevice::Create(), MythAirplayServer::Create(), MythPlayer::DecoderEnd(), MythPlayer::DecoderStart(), VideoScanner::doScan(), GameScanner::doScan(), FIFOWriter::FIFOInit(), GameUI::gameSearch(), NetTree::goBack(), NetTree::handleDirSelect(), HouseKeeper::HouseKeeper(), RecordingSelector::Init(), UPNPScanner::Instance(), DeviceReadBuffer::IsRunning(), RipStatus::keyPressEvent(), HouseKeeper::KillMFD(), RingBuffer::KillReadAheadThread(), DatabaseLogger::logmsg(), LogPrintLine(), logServerStart(), logStart(), MetadataFactory::Lookup(), MetadataDownload::prependLookup(), GrabberDownloadThread::refreshAll(), FileServerHandler::RunDeleteThread(), HouseKeeper::RunHouseKeeping(), Scheduler::Scheduler(), MusicCommon::seek(), DeviceReadBuffer::Start(), DeviceReadBuffer::Stop(), DecoderHandler::stop(), V4LRecorder::StopRecording(), MetadataFactory::SynchronousLookup(), AudioTest::toggle(), AudioTest::togglequality(), DeviceReadBuffer::WaitForUsed(), DeviceReadBuffer::WakePoll(), CECAdapter::~CECAdapter(), MythMainWindow::~MythMainWindow(), PrivateDecoderCrystalHD::~PrivateDecoderCrystalHD(), RingBuffer::~RingBuffer(), and VBIThread::~VBIThread().

void MThread::setStackSize ( uint stackSize )

Definition at line 276 of file mthread.cpp.

uint MThread::stackSize ( void ) const

Definition at line 281 of file mthread.cpp.

void MThread::exit ( int retcode = 0 )

Use this to exit from the thread if you are using a Qt event loop.

Definition at line 286 of file mthread.cpp.

Referenced by MythRAOPDevice::Cleanup(), MythAirplayServer::Cleanup(), StreamHandler::SetRunningDesired(), PreviewGeneratorQueue::TeardownPreviewGeneratorQueue(), CECAdapter::~CECAdapter(), and PlaybackBoxHelper::~PlaybackBoxHelper().

void MThread::start ( QThread::Priority p = QThread::InheritPriority )

Tell MThread to start running the thread in the near future.

Definition at line 291 of file mthread.cpp.

Referenced by MetadataImageDownload::addDownloads(), MetadataDownload::addLookup(), MetadataImageDownload::addThumb(), AutoExpire::AutoExpire(), CECAdapter::CECAdapter(), MythRAOPDevice::Create(), MythAirplayServer::Create(), DatabaseLogger::DatabaseLogger(), MusicPlayer::decoderHandlerReady(), MythPlayer::DecoderStart(), VideoScanner::doScan(), GameScanner::doScan(), GrabberManager::doUpdate(), GLSingleView::EffectKenBurns(), EITScanner::EITScanner(), FIFOWriter::FIFOInit(), finish_mpg(), CdDecoder::getMetadata(), GetMythDownloadManager(), GetRecordingListThread::GetRecordingListThread(), HouseKeeper::HouseKeeper(), TVRec::Init(), UPNPScanner::Instance(), isom_write_avcc(), JobQueue::JobQueue(), MythSystemWindows::JumpAbort(), MythSystemUnix::JumpAbort(), logServerStart(), logStart(), main(), MythSystemWindows::Manage(), MythSystemUnix::Manage(), MythMainWindow::MythMainWindow(), MythSocket::MythSocket(), MythSystemUnix::MythSystemUnix(), MythSystemWindows::MythSystemWindows(), NetworkControl::NetworkControl(), ThreadedFileWriter::Open(), HLSRingBuffer::OpenFile(), LinuxFirewireDevice::OpenPort(), PlaybackBoxHelper::PlaybackBoxHelper(), PlaylistContainer::PlaylistContainer(), MetadataDownload::prependLookup(), PreviewGeneratorQueue::PreviewGeneratorQueue(), GrabberDownloadThread::refreshAll(), MHIContext::Restart(), CDRipperThread::ripTrack(), NuppelVideoRecorder::run(), LogServerThread::run(), HLSRingBuffer::SanitizeStreams(), IPTVChannelFetcher::Scan(), Scheduler::Scheduler(), SSDP::SSDP(), DVBCam::Start(), SignalMonitor::Start(), DeviceReadBuffer::Start(), StreamHandler::Start(), RingBuffer::Start(), Ripper::startEjectCD(), PrivateDecoderCrystalHD::StartFetcherThread(), HouseKeeper::StartMFD(), MediaMonitorDarwin::StartMonitoring(), MediaMonitor::StartMonitoring(), AudioOutputBase::StartOutputThread(), RipStatus::startRip(), ImportMusicDialog::startScan(), Ripper::startScanCD(), ChannelScanSM::StartScanner(), TaskQueue::TaskQueue(), AudioTest::toggle(), AudioSetupWizard::toggleSpeakers(), MThreadPool::TryStartInternal(), TVRec::TuningNewRecorder(), TVBrowseHelper::TVBrowseHelper(), AutoExpire::Update(), GalleryFilterDialog::updateFilter(), VBIThread::VBIThread(), and MetadataFactory::VideoScan().

void MThread::terminate ( void )

Kill a thread unsafely.

This should never be called on a thread while it holds a mutex or semaphore, since those locks will never be unlocked. Use the static setTerminationEnabled(true) to tell MThread when it is safe to terminate the thread and setTerminationEnabled(false) to tell it that termination is not safe again.

Definition at line 298 of file mthread.cpp.

Referenced by HouseKeeper::KillMFD().

void MThread::quit ( void )

calls exit(0)

Definition at line 303 of file mthread.cpp.

Referenced by UPNPScanner::Instance(), LogServerThread::stop(), and MythSocket::~MythSocket().

void MThread::ThreadSetup ( const QString & name )

static

This is to be called on startup in those few threads that haven't been ported to MThread.

Definition at line 228 of file mthread.cpp.

Referenced by dfd_controller_thunk(), JobQueue::FlagCommercialsThread(), JobQueue::MetadataLookupThread(), MythCoreContextPrivate::MythCoreContextPrivate(), MPEG2fixup::ReplexStart(), RunProlog(), JobQueue::TranscodeThread(), and JobQueue::UserJobThread().