Used to expire recordings to make space for new recordings. More...

#include <mythbackend/autoexpire.h>

Inheritance diagram for AutoExpire:

Collaboration diagram for AutoExpire:

Public Member Functions
	AutoExpire (QMap< int, EncoderLink * > *tvList)
	Creates AutoExpire class, starting the thread. More...

	AutoExpire ()=default

	~AutoExpire () override
	AutoExpire destructor stops auto delete thread if it is running. More...

void	CalcParams (void)

void	PrintExpireList (const QString &expHost="ALL")
	Prints a summary of the files that can be deleted. More...

uint64_t	GetDesiredSpace (int fsID) const
	Used by the scheduler to select the next recording dir. More...

void	GetAllExpiring (QStringList &strList)
	Gets the full list of programs that can expire in expiration order. More...

void	GetAllExpiring (pginfolist_t &list)
	Gets the full list of programs that can expire in expiration order. More...

void	SetMainServer (MainServer *ms)

Static Public Member Functions
static void	ClearExpireList (pginfolist_t &expireList, bool deleteProg=true)
	Clears expireList, freeing any ProgramInfo's if necessary. More...

static void	Update (int encoder, int fsID, bool immediately)
	This is used to update the global AutoExpire instance "expirer". More...

static void	Update (bool immediately)

Public Attributes
QMap< int, EncoderLink * > *	m_encoderList {nullptr}

Protected Member Functions
void	RunExpirer (void)
	This contains the main loop for the auto expire process. More...

Private Member Functions
void	ExpireLiveTV (int type)
	This expires LiveTV programs. More...

void	ExpireOldDeleted (void)
	This expires deleted programs older than DeletedMaxAge. More...

void	ExpireQuickDeleted (void)
	This expires deleted programs within a few minutes. More...

void	ExpireRecordings (void)
	This expires normal recordings. More...

void	ExpireEpisodesOverMax (void)
	This deletes programs exceeding the maximum number of episodes of that program desired. Excludes recordings in the LiveTV Recording Group. More...

void	FillExpireList (pginfolist_t &expireList)
	Uses the "AutoExpireMethod" setting in the database to fill the list of files that are deletable. More...

void	FillDBOrdered (pginfolist_t &expireList, int expMethod)
	Creates a list of programs to delete using the database to order list. More...

void	Sleep (std::chrono::milliseconds sleepTime)
	Sleeps for sleepTime milliseconds; unless the expire thread is told to quit. More...

void	UpdateDontExpireSet (void)

bool	IsInDontExpireSet (uint chanid, const QDateTime &recstartts) const

Static Private Member Functions
static void	SendDeleteMessages (pginfolist_t &deleteList)
	This sends delete message to main event thread. More...

static bool	IsInExpireList (const pginfolist_t &expireList, uint chanid, const QDateTime &recstartts)

Private Attributes
QSet< QString >	m_dontExpireSet

ExpireThread *	m_expireThread {nullptr}

uint	m_desiredFreq {15}

bool	m_expireThreadRun {false}

QMap< int, int64_t >	m_desiredSpace

QMap< int, int >	m_usedEncoders

QMutex	m_instanceLock

QWaitCondition	m_instanceCond

MainServer *	m_mainServer {nullptr}

QMutex	m_updateLock

QQueue< UpdateEntry >	m_updateQueue

Friends
class	ExpireThread

Detailed Description

Used to expire recordings to make space for new recordings.

Definition at line 60 of file autoexpire.h.

Constructor & Destructor Documentation

◆ AutoExpire() [1/2]

AutoExpire::AutoExpire ( QMap< int, EncoderLink * > * tvList )

explicit

Creates AutoExpire class, starting the thread.

Parameters

tvList EncoderLink list of all recorders

Definition at line 74 of file autoexpire.cpp.

◆ AutoExpire() [2/2]

AutoExpire::AutoExpire ( )

default

◆ ~AutoExpire()

AutoExpire::~AutoExpire ( )

override

AutoExpire destructor stops auto delete thread if it is running.

Definition at line 86 of file autoexpire.cpp.

Member Function Documentation

◆ CalcParams()

void AutoExpire::CalcParams ( void )

Calculates how much space needs to be cleared, and how often.

Definition at line 124 of file autoexpire.cpp.

Referenced by RunExpirer(), and Update().

◆ PrintExpireList()

void AutoExpire::PrintExpireList ( const QString & expHost = "ALL" )

Prints a summary of the files that can be deleted.

Definition at line 795 of file autoexpire.cpp.

Referenced by handle_command().

◆ GetDesiredSpace()

uint64_t AutoExpire::GetDesiredSpace ( int fsID ) const

Used by the scheduler to select the next recording dir.

Returns: the desired free space for each file system

Definition at line 113 of file autoexpire.cpp.

Referenced by Scheduler::FillRecordingDir().

◆ GetAllExpiring() [1/2]

void AutoExpire::GetAllExpiring ( QStringList & strList )

Gets the full list of programs that can expire in expiration order.

Definition at line 834 of file autoexpire.cpp.

Referenced by Scheduler::FillRecordingDir(), V2Dvr::GetExpiringList(), and MainServer::HandleGetExpiringRecordings().

◆ GetAllExpiring() [2/2]

void AutoExpire::GetAllExpiring ( pginfolist_t & list )

Gets the full list of programs that can expire in expiration order.

Definition at line 858 of file autoexpire.cpp.

◆ ClearExpireList()

void AutoExpire::ClearExpireList	(	pginfolist_t &	expireList,
		bool	deleteProg = `true`
	)

static

Clears expireList, freeing any ProgramInfo's if necessary.

Definition at line 880 of file autoexpire.cpp.

Referenced by ExpireLiveTV(), ExpireOldDeleted(), ExpireQuickDeleted(), ExpireRecordings(), FillExpireList(), Scheduler::FillRecordingDir(), GetAllExpiring(), and PrintExpireList().

◆ Update() [1/2]

void AutoExpire::Update	(	int	encoder,
		int	fsID,
		bool	immediately
	)

static

This is used to update the global AutoExpire instance "expirer".

Parameters

encoder	This recorder starts a recording now
fsID	file system ID of the writing directory
immediately	If true CalcParams() is called directly. If false, a thread is spawned to call CalcParams(), this is for use in the MainServer event thread where calling CalcParams() directly would deadlock the event thread.

Definition at line 1038 of file autoexpire.cpp.

Referenced by MainServer::autoexpireUpdate(), Scheduler::GetNextLiveTVDir(), Scheduler::HandleRecording(), and MainServer::MainServer().

◆ Update() [2/2]

static void AutoExpire::Update ( bool immediately )

inlinestatic

Definition at line 80 of file autoexpire.h.

Referenced by Update().

◆ SetMainServer()

void AutoExpire::SetMainServer ( MainServer * ms )

inline

Definition at line 82 of file autoexpire.h.

Referenced by MainServer::MainServer(), and MainServer::Stop().

◆ RunExpirer()

void AutoExpire::RunExpirer ( void )

protected

This contains the main loop for the auto expire process.

Responsible for cleanup of old LiveTV programs as well as deleting as many recordings that are expirable as necessary to maintain enough free space on all directories in MythTV Storage Groups. The thread deletes short LiveTV programs every 2 minutes and long LiveTV and regular programs as needed every "desired_freq" minutes.

Definition at line 272 of file autoexpire.cpp.

◆ ExpireLiveTV()

void AutoExpire::ExpireLiveTV ( int type )

private

This expires LiveTV programs.

Definition at line 365 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ ExpireOldDeleted()

void AutoExpire::ExpireOldDeleted ( void )

private

This expires deleted programs older than DeletedMaxAge.

Definition at line 378 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ ExpireQuickDeleted()

void AutoExpire::ExpireQuickDeleted ( void )

private

This expires deleted programs within a few minutes.

Definition at line 391 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ ExpireRecordings()

void AutoExpire::ExpireRecordings ( void )

private

This expires normal recordings.

Definition at line 405 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ ExpireEpisodesOverMax()

void AutoExpire::ExpireEpisodesOverMax ( void )

private

This deletes programs exceeding the maximum number of episodes of that program desired. Excludes recordings in the LiveTV Recording Group.

Definition at line 654 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ FillExpireList()

void AutoExpire::FillExpireList ( pginfolist_t & expireList )

private

Uses the "AutoExpireMethod" setting in the database to fill the list of files that are deletable.

Definition at line 773 of file autoexpire.cpp.

Referenced by ExpireRecordings(), and PrintExpireList().

◆ FillDBOrdered()

void AutoExpire::FillDBOrdered	(	pginfolist_t &	expireList,
		int	expMethod
	)

private

Creates a list of programs to delete using the database to order list.

Definition at line 899 of file autoexpire.cpp.

Referenced by ExpireLiveTV(), ExpireOldDeleted(), ExpireQuickDeleted(), FillExpireList(), and GetAllExpiring().

◆ SendDeleteMessages()

void AutoExpire::SendDeleteMessages ( pginfolist_t & deleteList )

staticprivate

This sends delete message to main event thread.

Definition at line 617 of file autoexpire.cpp.

Referenced by ExpireLiveTV(), ExpireOldDeleted(), ExpireQuickDeleted(), and ExpireRecordings().

◆ Sleep()

void AutoExpire::Sleep ( std::chrono::milliseconds sleepTime )

private

Sleeps for sleepTime milliseconds; unless the expire thread is told to quit.

Must be called with instance_lock held.

Note: Will release instance_lock!

Definition at line 348 of file autoexpire.cpp.

Referenced by RunExpirer().

◆ UpdateDontExpireSet()

void AutoExpire::UpdateDontExpireSet ( void )

private

Definition at line 1073 of file autoexpire.cpp.

Referenced by GetAllExpiring(), and RunExpirer().

◆ IsInDontExpireSet()

bool AutoExpire::IsInDontExpireSet	(	uint	chanid,
		const QDateTime &	recstartts
	)		const

private

Definition at line 1109 of file autoexpire.cpp.

Referenced by ExpireEpisodesOverMax(), and FillDBOrdered().

◆ IsInExpireList()

bool AutoExpire::IsInExpireList	(	const pginfolist_t &	expireList,
		uint	chanid,
		const QDateTime &	recstartts
	)

staticprivate

Definition at line 1118 of file autoexpire.cpp.

Referenced by FillDBOrdered().

Friends And Related Function Documentation

◆ ExpireThread

friend class ExpireThread

friend

Definition at line 64 of file autoexpire.h.

Member Data Documentation

◆ m_encoderList

QMap<int, EncoderLink *>* AutoExpire::m_encoderList {nullptr}

Definition at line 88 of file autoexpire.h.

Referenced by CalcParams(), and ExpireRecordings().

◆ m_dontExpireSet

QSet<QString> AutoExpire::m_dontExpireSet

private

Definition at line 111 of file autoexpire.h.

Referenced by IsInDontExpireSet(), and UpdateDontExpireSet().

◆ m_expireThread

ExpireThread* AutoExpire::m_expireThread {nullptr}

private

Definition at line 112 of file autoexpire.h.

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

◆ m_desiredFreq

uint AutoExpire::m_desiredFreq {15}

private

Definition at line 113 of file autoexpire.h.

Referenced by CalcParams(), and RunExpirer().

◆ m_expireThreadRun

bool AutoExpire::m_expireThreadRun {false}

private

Definition at line 114 of file autoexpire.h.

Referenced by RunExpirer(), Sleep(), and ~AutoExpire().

◆ m_desiredSpace

QMap<int, int64_t> AutoExpire::m_desiredSpace

private

Definition at line 116 of file autoexpire.h.

Referenced by CalcParams(), ExpireRecordings(), and GetDesiredSpace().

◆ m_usedEncoders

QMap<int, int> AutoExpire::m_usedEncoders

private

Definition at line 117 of file autoexpire.h.

Referenced by CalcParams(), RunExpirer(), and Update().

◆ m_instanceLock

QMutex AutoExpire::m_instanceLock

mutableprivate

Definition at line 119 of file autoexpire.h.

Referenced by CalcParams(), GetAllExpiring(), GetDesiredSpace(), RunExpirer(), SetMainServer(), Sleep(), Update(), and ~AutoExpire().

◆ m_instanceCond

QWaitCondition AutoExpire::m_instanceCond

private

Definition at line 120 of file autoexpire.h.

Referenced by Sleep(), Update(), and ~AutoExpire().

◆ m_mainServer

MainServer* AutoExpire::m_mainServer {nullptr}

private

Definition at line 122 of file autoexpire.h.

Referenced by CalcParams(), ExpireRecordings(), and SetMainServer().

◆ m_updateLock

QMutex AutoExpire::m_updateLock

private

Definition at line 125 of file autoexpire.h.

Referenced by RunExpirer(), Update(), and ~AutoExpire().

◆ m_updateQueue

QQueue<UpdateEntry> AutoExpire::m_updateQueue

private

Definition at line 126 of file autoexpire.h.

Referenced by RunExpirer(), Update(), and ~AutoExpire().

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

mythtv/programs/mythbackend/autoexpire.h
mythtv/programs/mythbackend/autoexpire.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AutoExpire() [1/2]

◆ AutoExpire() [2/2]

◆ ~AutoExpire()

Member Function Documentation

◆ CalcParams()

◆ PrintExpireList()

◆ GetDesiredSpace()

◆ GetAllExpiring() [1/2]

◆ GetAllExpiring() [2/2]

◆ ClearExpireList()

◆ Update() [1/2]

◆ Update() [2/2]

◆ SetMainServer()

◆ RunExpirer()

◆ ExpireLiveTV()

◆ ExpireOldDeleted()

◆ ExpireQuickDeleted()

◆ ExpireRecordings()

◆ ExpireEpisodesOverMax()

◆ FillExpireList()

◆ FillDBOrdered()

◆ SendDeleteMessages()

◆ Sleep()

◆ UpdateDontExpireSet()

◆ IsInDontExpireSet()

◆ IsInExpireList()

Friends And Related Function Documentation

◆ ExpireThread

Member Data Documentation

◆ m_encoderList

◆ m_dontExpireSet

◆ m_expireThread

◆ m_desiredFreq

◆ m_expireThreadRun

◆ m_desiredSpace

◆ m_usedEncoders

◆ m_instanceLock

◆ m_instanceCond

◆ m_mainServer

◆ m_updateLock

◆ m_updateQueue