AutoExpire Class Reference

#include <autoexpire.h>

Detailed Description

Used to expire recordings to make space for new recordings.

Definition at line 35 of file autoexpire.h.


Public Member Functions
	AutoExpire (QMap< int, EncoderLink * > *encoderList)
	Creates AutoExpire class, starting the thread.
	AutoExpire (void)
	Creates AutoExpire class.
	~AutoExpire ()
	AutoExpire destructor stops auto delete thread if it is running.
void	CalcParams (void)
	Calcualtes how much space needs to be cleared, and how often.
void	PrintExpireList (QString expHost="ALL")
	Prints a summary of the files that can be deleted.
size_t	GetDesiredSpace (int fsID) const
void	GetAllExpiring (QStringList &strList)
	Gets the full list of programs that can expire in expiration order.
void	GetAllExpiring (pginfolist_t &list)
	Gets the full list of programs that can expire in expiration order.
Static Public Member Functions
static void	Update (int encoder, int fsID, bool immediately)
	This is used to update the global AutoExpire instance "expirer".
static void	Update (bool immediately)
Public Attributes
QMap< int, EncoderLink * > *	encoderList
Protected Member Functions
void	RunExpirer (void)
	This contains the main loop for the auto expire process.
Static Protected Member Functions
static void *	ExpirerThread (void *param)
	This calls RunExpirer() from within a new pthread.
Private Member Functions
void	Init (void)
	Inits member vars.
void	ExpireLiveTV (int type)
	This expires LiveTV programs.
void	ExpireOldDeleted (void)
	This expires deleted programs older than DeletedMaxAge.
void	ExpireRecordings (void)
	This expires normal recordings.
void	ExpireEpisodesOverMax (void)
	This deletes programs exceeding the maximum number of episodes of that program desired.
void	FillExpireList (pginfolist_t &expireList)
	Uses the "AutoExpireMethod" setting in the database to fill the list of files that are deletable.
void	FillDBOrdered (pginfolist_t &expireList, int expMethod)
	Creates a list of programs to delete using the database to order list.
void	SendDeleteMessages (pginfolist_t &deleteList)
	This sends delete message to main event thread.
void	ClearExpireList (pginfolist_t &expireList, bool deleteProg=true)
	Clears expireList, freeing any ProgramInfo's if necessary.
void	Sleep (int sleepTime)
	Sleeps for sleepTime minutes; unless the expire thread is told to quit, then stops sleeping within 5 seconds.
void	UpdateDontExpireSet (void)
bool	IsInDontExpireSet (QString chanid, QDateTime starttime)
bool	IsInExpireList (pginfolist_t &expireList, QString chanid, QDateTime starttime)
Private Attributes
set< QString >	dont_expire_set
pthread_t	expire_thread
uint	desired_freq
bool	expire_thread_running
QMap< int, uint64_t >	desired_space
QMap< int, int >	used_encoders
QMutex	instance_lock
QWaitCondition	instance_cond
bool	update_pending
pthread_t	update_thread
Friends
void *	SpawnUpdateThread (void *param)

Constructor & Destructor Documentation

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

Creates AutoExpire class, starting the thread.

Parameters:

tvList

EncoderLink list of all recorders

Definition at line 58 of file autoexpire.cpp.

AutoExpire::AutoExpire ( void )

Creates AutoExpire class.

Definition at line 72 of file autoexpire.cpp.

AutoExpire::~AutoExpire ( )

AutoExpire destructor stops auto delete thread if it is running.

Definition at line 91 of file autoexpire.cpp.

Member Function Documentation

void AutoExpire::CalcParams ( void )

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

Definition at line 124 of file autoexpire.cpp.

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

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

Prints a summary of the files that can be deleted.

Definition at line 760 of file autoexpire.cpp.

Referenced by main().

size_t AutoExpire::GetDesiredSpace ( int fsID ) const

Definition at line 114 of file autoexpire.cpp.

Referenced by Scheduler::FillRecordingDir().

void AutoExpire::GetAllExpiring ( QStringList & strList )

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

Definition at line 799 of file autoexpire.cpp.

Referenced by MythXML::GetExpiring(), and MainServer::HandleGetExpiringRecordings().

void AutoExpire::GetAllExpiring ( pginfolist_t & list )

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

Definition at line 824 of file autoexpire.cpp.

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 1043 of file autoexpire.cpp.

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

static void AutoExpire::Update ( bool immediately ) [inline, static]

Definition at line 51 of file autoexpire.h.

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 expireable recordings 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 262 of file autoexpire.cpp.

Referenced by ExpirerThread().

void * AutoExpire::ExpirerThread ( void * param ) [static, protected]

This calls RunExpirer() from within a new pthread.

Definition at line 605 of file autoexpire.cpp.

Referenced by AutoExpire().

void AutoExpire::Init ( void ) [private]

Inits member vars.

Definition at line 82 of file autoexpire.cpp.

Referenced by AutoExpire().

void AutoExpire::ExpireLiveTV ( int type ) [private]

This expires LiveTV programs.