A generator worker thread. More...

#include <libmythmetadata/imagethumbs.h>

Inheritance diagram for ThumbThread< DBFS >:

Collaboration diagram for ThumbThread< DBFS >:

Public Member Functions
	ThumbThread (const QString &name, DBFS *const dbfs)
	Constructor. More...

	~ThumbThread () override
	Destructor. More...

void	cancel ()
	Clears all queues so that the thread will terminate. More...

void	Enqueue (const TaskPtr &task)
	Queues a Create request. More...

void	AbortDevice (int devId, const QString &action)
	Clears thumbnail request queue. More...

void	PauseBackground (bool pause)
	Pauses or restarts processing of background tasks (scanner requests) More...

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 ()

	MThread (const MThread &)=delete

MThread &	operator= (const MThread &)=delete

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 p=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 (std::chrono::milliseconds time=std::chrono::milliseconds::max())
	Wait for the MThread to exit, with a maximum timeout. More...

Protected Member Functions
void	run () override
	Handles thumbnail requests by priority. More...

Protected Member Functions inherited from MThread
int	exec (void)
	Enters the qt event loop. call exit or quit to exit thread. More...

Private Types
using	ThumbQueue = QMultiMap< int, TaskPtr >
	A priority queue where 0 is highest priority. More...

Private Member Functions
QString	CreateThumbnail (const ImagePtrK &im, int thumbPriority)
	Generate thumbnail for an image. More...

Static Private Member Functions
static void	RemoveTasks (ThumbQueue &queue, int devId)

Private Attributes
DBFS &	m_dbfs
	Database/filesystem adapter. More...

QWaitCondition	m_taskDone

ThumbQueue	m_requestQ
	Synchronises completed tasks. More...

ThumbQueue	m_backgroundQ
	Priority queue of background tasks. More...

bool	m_doBackground {true}
	Whether to process background tasks. More...

QMutex	m_mutex
	Queue protection. More...

Additional Inherited Members
Static Public Member Functions inherited from MThread
static void	ThreadSetup (const QString &name)
	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)

Static Protected Member Functions inherited from MThread
static void	setTerminationEnabled (bool enabled=true)

static void	usleep (std::chrono::microseconds time)

template<typename R , typename P >
static std::enable_if_t< std::chrono::treat_as_floating_point< R >::value, void >	usleep (std::chrono::duration< R, P > time)

Protected Attributes inherited from MThread
MThreadInternal *	m_thread {nullptr}

QRunnable *	m_runnable {nullptr}

bool	m_prologExecuted {true}

bool	m_epilogExecuted {true}

Detailed Description

template<class DBFS>
class ThumbThread< DBFS >

A generator worker thread.

Definition at line 87 of file imagethumbs.h.

Member Typedef Documentation

◆ ThumbQueue

template<class DBFS >

using ThumbThread< DBFS >::ThumbQueue = QMultiMap<int, TaskPtr>

private

A priority queue where 0 is highest priority.

Definition at line 111 of file imagethumbs.h.

Constructor & Destructor Documentation

◆ ThumbThread()

template<class DBFS >

ThumbThread< DBFS >::ThumbThread	(	const QString &	name,
		DBFS *const	dbfs
	)

inline

Constructor.

Parameters

name	Thread name
dbfs	Filesystem/Database adapter

Definition at line 95 of file imagethumbs.h.

◆ ~ThumbThread()

template<class DBFS >

ThumbThread< DBFS >::~ThumbThread

override

Destructor.

Definition at line 18 of file imagethumbs.cpp.

Member Function Documentation

◆ cancel()

template<class DBFS >

void ThumbThread< DBFS >::cancel

Clears all queues so that the thread will terminate.

Definition at line 29 of file imagethumbs.cpp.

◆ Enqueue()

template<class DBFS >

void ThumbThread< DBFS >::Enqueue ( const TaskPtr & task )

Queues a Create request.

Parameters

task	The request

Definition at line 43 of file imagethumbs.cpp.

◆ AbortDevice()

template<class DBFS >

void ThumbThread< DBFS >::AbortDevice	(	int	devId,
		const QString &	action
	)

Clears thumbnail request queue.

Warning: May block for several seconds

Definition at line 67 of file imagethumbs.cpp.

◆ PauseBackground()

template<class DBFS >

void ThumbThread< DBFS >::PauseBackground ( bool pause )

Pauses or restarts processing of background tasks (scanner requests)

Definition at line 325 of file imagethumbs.cpp.

◆ run()

template<class DBFS >

void ThumbThread< DBFS >::run

overrideprotectedvirtual

Handles thumbnail requests by priority.

Repeatedly processes next request from highest priority queue until all queues are empty, then quits. For Create requests an event is broadcast once the thumbnail exists. Dirs are only deleted if empty

Reimplemented from MThread.

Definition at line 123 of file imagethumbs.cpp.

◆ CreateThumbnail()

template<class DBFS >

QString ThumbThread< DBFS >::CreateThumbnail	(	const ImagePtrK &	im,
		int	thumbPriority
	)

private

Generate thumbnail for an image.

Parameters

im	Image
thumbPriority

Definition at line 240 of file imagethumbs.cpp.

◆ RemoveTasks()

template<class DBFS >

void ThumbThread< DBFS >::RemoveTasks	(	ThumbQueue &	queue,
		int	devId
	)

QMutex ThumbThread< DBFS >::m_mutex

private

Queue protection.

Definition at line 122 of file imagethumbs.h.

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

mythtv/libs/libmythmetadata/imagethumbs.h
mythtv/libs/libmythmetadata/imagethumbs.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class DBFS> class ThumbThread< DBFS >

Member Typedef Documentation

◆ ThumbQueue

Constructor & Destructor Documentation

◆ ThumbThread()

◆ ~ThumbThread()

Member Function Documentation

◆ cancel()

◆ Enqueue()

◆ AbortDevice()

◆ PauseBackground()

◆ run()

◆ CreateThumbnail()

◆ RemoveTasks()

Member Data Documentation

◆ m_dbfs

◆ m_taskDone

◆ m_requestQ

◆ m_backgroundQ

◆ m_doBackground

◆ m_mutex

template<class DBFS>
class ThumbThread< DBFS >