vdr 2.8.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
cThread Class Referenceabstract

#include <thread.h>

Public Member Functions

 cThread (const char *Description=NULL, bool LowPriority=false)
virtual ~cThread ()
void SetDescription (const char *Description,...) __attribute__((format(printf
void bool Start (void)
bool Active (void)

Static Public Member Functions

static tThreadId ThreadId (void)
static tThreadId IsMainThread (void)
static void SetMainThreadId (void)

Protected Member Functions

void SetPriority (int Priority)
void SetIOPriority (int Priority)
void Lock (void)
void Unlock (void)
virtual void Action (void)=0
bool Running (void)
void Cancel (int WaitSeconds=0)

Static Private Member Functions

static void * StartThread (cThread *Thread)

Private Attributes

std::atomic< bool > active
std::atomic< bool > running
pthread_t childTid
std::atomic< tThreadId > childThreadId
cMutex mutex
char * description
bool lowPriority

Static Private Attributes

static tThreadId mainThreadId = 0

Friends

class cThreadLock

Detailed Description

Definition at line 86 of file thread.h.

Constructor & Destructor Documentation

◆ cThread()

cThread::cThread ( const char * Description = NULL,
bool LowPriority = false )

Creates a new thread.

If Description is present, a log file entry will be made when the thread starts and stops (see SetDescription()). The Start() function must be called to actually start the thread. LowPriority can be set to true to make this thread run at a lower priority.

Definition at line 264 of file thread.c.

References active, childThreadId, childTid, description, lowPriority, running, and SetDescription().

Referenced by cCiAdapter::cCiAdapter(), cCuttingThread::cCuttingThread(), cDirCopier::cDirCopier(), cDvbPlayer::cDvbPlayer(), cDvbSubtitleConverter::cDvbSubtitleConverter(), cEpgDataReader::cEpgDataReader(), cEpgDataWriter::cEpgDataWriter(), cIndexFileGenerator::cIndexFileGenerator(), cKbdRemote::cKbdRemote(), cLircRemote::cLircRemote(), cNonBlockingFileReader::cNonBlockingFileReader(), cRecorder::cRecorder(), cRecordingsHandler::cRecordingsHandler(), cRemoveDeletedRecordingsThread::cRemoveDeletedRecordingsThread(), cSectionHandler::cSectionHandler(), cSpinUpDisk::cSpinUpDisk(), cSVDRPClientHandler::cSVDRPClientHandler(), cSVDRPServerHandler::cSVDRPServerHandler(), cVideoDirectoryScannerThread::cVideoDirectoryScannerThread(), and StartThread().

◆ ~cThread()

cThread::~cThread ( )
virtual

Definition at line 275 of file thread.c.

References Cancel(), and description.

Member Function Documentation

◆ Action()

virtual void cThread::Action ( void )
protectedpure virtual

A derived cThread class must implement the code it wants to execute as a separate thread in this function.

If this is a loop, it must check Running() repeatedly to see whether it's time to stop.

Implemented in cCiAdapter, cCuttingThread, cDevice, cDirCopier, cDvbPlayer, cDvbSubtitleConverter, cDvbTuner, cEpgDataReader, cEpgDataWriter, cIndexFileGenerator, cKbdRemote, cLircDevRemote, cLircUsrRemote, cNonBlockingFileReader, cRecorder, cRecordingsHandler, cRemoveDeletedRecordingsThread, cSectionHandler, cSpinUpDisk, cSVDRPClientHandler, cSVDRPServerHandler, cTrueColorDemo, cTSBuffer, and cVideoDirectoryScannerThread.

Referenced by StartThread().

◆ Active()

bool cThread::Active ( void )

Checks whether the thread is still alive.

Definition at line 355 of file thread.c.

References active, childTid, LOG_ERROR, and running.

Referenced by cCutter::Active(), cRecordingsHandlerEntry::Active(), Cancel(), cSpinUpDisk::Check(), cSchedules::Cleanup(), cShutdownHandler::ConfirmRestart(), cShutdownHandler::ConfirmShutdown(), GenerateIndex(), main(), RemoveDeletedRecordings(), cCutter::Stop(), cMenuMain::Update(), and cRecordings::Update().

◆ Cancel()

void cThread::Cancel ( int WaitSeconds = 0)
protected

Cancels the thread by first setting 'running' to false, so that the Action() loop can finish in an orderly fashion and then waiting up to WaitSeconds seconds for the thread to actually end.

If the thread doesn't end by itself, it is killed. If WaitSeconds is -1, only 'running' is set to false and Cancel() returns immediately, without killing the thread.

Definition at line 380 of file thread.c.

References Active(), active, childThreadId, childTid, description, esyslog, running, cCondWait::SleepMs(), and cTimeMs::TimedOut().

Referenced by cDvbPlayer::Activate(), cRecorder::Activate(), cDevice::Detach(), cTrueColorDemo::ProcessKey(), cRecorder::Stop(), cCiAdapter::~cCiAdapter(), cCuttingThread::~cCuttingThread(), cDevice::~cDevice(), cDirCopier::~cDirCopier(), cDvbCiAdapter::~cDvbCiAdapter(), cDvbDevice::~cDvbDevice(), cDvbSubtitleConverter::~cDvbSubtitleConverter(), cDvbTuner::~cDvbTuner(), cIndexFileGenerator::~cIndexFileGenerator(), cKbdRemote::~cKbdRemote(), cLircRemote::~cLircRemote(), cNonBlockingFileReader::~cNonBlockingFileReader(), cRecorder::~cRecorder(), cRecordingsHandler::~cRecordingsHandler(), cSectionHandler::~cSectionHandler(), cSVDRPClientHandler::~cSVDRPClientHandler(), cSVDRPServerHandler::~cSVDRPServerHandler(), ~cThread(), cTrueColorDemo::~cTrueColorDemo(), cTSBuffer::~cTSBuffer(), and cVideoDirectoryScannerThread::~cVideoDirectoryScannerThread().

◆ IsMainThread()

tThreadId cThread::IsMainThread ( void )
inlinestatic

Definition at line 140 of file thread.h.

References IsMainThread(), mainThreadId, and ThreadId().

Referenced by cPlugin::CacheDirectory(), cPlugin::ConfigDirectory(), cControl::Control(), IsMainThread(), cSkins::Message(), cSkins::ProcessQueuedMessages(), cSkins::QueueMessage(), cPlugin::ResourceDirectory(), and cDvbPlayer::SetAudioTrack().

◆ Lock()

void cThread::Lock ( void )
inlineprotected

Definition at line 103 of file thread.h.

References cMutex::Lock(), and mutex.

Referenced by cDevice::Action(), cNonBlockingFileReader::Action(), cSectionHandler::Action(), cSectionHandler::Add(), cSectionHandler::Attach(), cNonBlockingFileReader::Clear(), cSectionHandler::Del(), cSectionHandler::Detach(), cThreadLock::Lock(), cNonBlockingFileReader::Request(), cDvbSubtitleConverter::Reset(), cSectionHandler::SetChannel(), and cSectionHandler::SetStatus().

◆ Running()

bool cThread::Running ( void )
inlineprotected

Returns false if a derived cThread object shall leave its Action() function.

Definition at line 110 of file thread.h.

References running.

Referenced by cCiAdapter::Action(), cCuttingThread::Action(), cDevice::Action(), cDirCopier::Action(), cDvbPlayer::Action(), cDvbSubtitleConverter::Action(), cDvbTuner::Action(), cIndexFileGenerator::Action(), cKbdRemote::Action(), cLircDevRemote::Action(), cLircUsrRemote::Action(), cNonBlockingFileReader::Action(), cRecorder::Action(), cRecordingsHandler::Action(), cSectionHandler::Action(), cSVDRPClientHandler::Action(), cSVDRPServerHandler::Action(), cTrueColorDemo::Action(), cTSBuffer::Action(), cDvbPlayer::Active(), cCuttingThread::ProcessSequence(), and cVideoDirectoryScannerThread::ScanVideoDir().

◆ SetDescription()

void cThread::SetDescription ( const char * Description,
... )

Definition at line 293 of file thread.c.

References description, and cString::vsprintf().

Referenced by cDevice::cDevice(), cDvbCiAdapter::cDvbCiAdapter(), cDvbTuner::cDvbTuner(), cSectionHandler::cSectionHandler(), cThread(), and cTSBuffer::cTSBuffer().

◆ SetIOPriority()

void cThread::SetIOPriority ( int Priority)
protected

Definition at line 287 of file thread.c.

References LOG_ERROR.

Referenced by StartThread().

◆ SetMainThreadId()

void cThread::SetMainThreadId ( void )
static

Definition at line 412 of file thread.c.

References esyslog, mainThreadId, and ThreadId().

Referenced by main().

◆ SetPriority()

void cThread::SetPriority ( int Priority)
protected

Definition at line 281 of file thread.c.

References LOG_ERROR.

Referenced by StartThread().

◆ Start()

bool cThread::Start ( void )

Sets the description of this thread, which will be used when logging starting or stopping of the thread.

Make sure any important information is within the first 15 characters of Description, because only these may be displayed in thread listings (like 'htop', for instance). Actually starts the thread. If the thread is already running, nothing happens.

Definition at line 330 of file thread.c.

References active, childTid, cTimeMs::Elapsed(), LOG_ERROR, running, cCondWait::SleepMs(), StartThread(), THREAD_STOP_SLEEP, and THREAD_STOP_TIMEOUT.

Referenced by cTrueColorDemo::Action(), cDvbPlayer::Activate(), cRecorder::Activate(), cRecordingsHandlerEntry::Active(), cRecordingsHandler::Add(), cDevice::AttachReceiver(), cCuttingThread::cCuttingThread(), cDvbCiAdapter::cDvbCiAdapter(), cDvbSubtitleConverter::cDvbSubtitleConverter(), cDvbTuner::cDvbTuner(), cSpinUpDisk::Check(), cIndexFileGenerator::cIndexFileGenerator(), cKbdRemote::cKbdRemote(), cSchedules::Cleanup(), cLircUsrRemote::cLircUsrRemote(), cNonBlockingFileReader::cNonBlockingFileReader(), cLircDevRemote::Connect(), cSectionHandler::cSectionHandler(), cTSBuffer::cTSBuffer(), main(), cDevice::PlayPesPacket(), RemoveDeletedRecordings(), cTrueColorDemo::Show(), StartSVDRPHandler(), and cRecordings::Update().

◆ StartThread()

void * cThread::StartThread ( cThread * Thread)
staticprivate

Definition at line 305 of file thread.c.

References Action(), active, childThreadId, cThread(), description, dsyslog, esyslog, lowPriority, running, SetIOPriority(), SetPriority(), and ThreadId().

Referenced by Start().

◆ ThreadId()

tThreadId cThread::ThreadId ( void )
static

Definition at line 399 of file thread.c.

Referenced by cIoThrottle::Activate(), cStateLockLog::Check(), cSkinQueuedMessage::cSkinQueuedMessage(), cRingBufferLinear::Get(), IsMainThread(), cMutex::Lock(), cRwLock::Lock(), cStateLock::Lock(), main(), cSkins::QueueMessage(), cIoThrottle::Release(), cStateLock::SetExplicitModify(), SetMainThreadId(), cStateLock::SetModified(), cStateLock::SetSyncStateKey(), StartThread(), cStateKey::StateChanged(), syslog_with_tid(), cCondVar::TimedWait(), cRwLock::Unlock(), cStateLock::Unlock(), and cCondVar::Wait().

◆ Unlock()

void cThread::Unlock ( void )
inlineprotected

Definition at line 104 of file thread.h.

References mutex, and cMutex::Unlock().

Referenced by cDevice::Action(), cNonBlockingFileReader::Action(), cSectionHandler::Action(), cSectionHandler::Add(), cSectionHandler::Attach(), cNonBlockingFileReader::Clear(), cSectionHandler::Del(), cSectionHandler::Detach(), cNonBlockingFileReader::Request(), cDvbSubtitleConverter::Reset(), cSectionHandler::SetChannel(), cSectionHandler::SetStatus(), and cThreadLock::~cThreadLock().

◆ cThreadLock

friend class cThreadLock
friend

Definition at line 87 of file thread.h.

References cThreadLock.

Referenced by cThreadLock.

Member Data Documentation

◆ active

std::atomic<bool> cThread::active
private

Definition at line 91 of file thread.h.

Referenced by Active(), Cancel(), cThread(), Start(), and StartThread().

◆ childThreadId

std::atomic<tThreadId> cThread::childThreadId
private

Definition at line 94 of file thread.h.

Referenced by Cancel(), cThread(), and StartThread().

◆ childTid

pthread_t cThread::childTid
private

Definition at line 93 of file thread.h.

Referenced by Active(), Cancel(), cThread(), and Start().

◆ description

char* cThread::description
private

Definition at line 96 of file thread.h.

Referenced by Cancel(), cDevice::ClrAvailableTracks(), cThread(), cDevice::SetAvailableTrack(), SetDescription(), StartThread(), and ~cThread().

◆ lowPriority

bool cThread::lowPriority
private

Definition at line 97 of file thread.h.

Referenced by cThread(), and StartThread().

◆ mainThreadId

tThreadId cThread::mainThreadId = 0
staticprivate

Definition at line 98 of file thread.h.

Referenced by IsMainThread(), and SetMainThreadId().

◆ mutex

cMutex cThread::mutex
private

Definition at line 95 of file thread.h.

Referenced by Lock(), and Unlock().

◆ running

std::atomic<bool> cThread::running
private

Definition at line 92 of file thread.h.

Referenced by Active(), Cancel(), cThread(), Running(), Start(), and StartThread().

The documentation for this class was generated from the following files:
Generated by doxygen 1.18.0