C4StartupModsLocalModDiscovery Class Reference

#include <C4StartupModsDlg.h>

Inheritance diagram for C4StartupModsLocalModDiscovery:

Collaboration diagram for C4StartupModsLocalModDiscovery:

Classes
struct	ModsInfo

Public Member Functions
	C4StartupModsLocalModDiscovery (C4StartupModsDlg *parent)
bool	IsDiscoveryFinished () const
void	WaitForDiscoveryFinished ()
const bool	IsModInstalled (const std::string &id)
ModsInfo	GetModInformation (const std::string &id)
void	RemoveMod (const std::string &id)
ModsInfo &	AddMod (const std::string &id, const std::string &path, const std::string &name)
const std::map< std::string, ModsInfo > &	GetAllModInformation ()
CStdLock	Lock ()
bool	Start ()
void	SignalStop ()
void	Stop ()
bool	IsStarted ()

Protected Member Functions
void	Execute () override
bool	IsStopSignaled ()
virtual bool	IsSelfDestruct ()

Detailed Description

Definition at line 71 of file C4StartupModsDlg.h.

---

Class Documentation

C4StartupModsLocalModDiscovery::ModsInfo

struct C4StartupModsLocalModDiscovery::ModsInfo

Definition at line 83 of file C4StartupModsDlg.h.

Class Members
string	id
string	name
string	path

Constructor & Destructor Documentation

C4StartupModsLocalModDiscovery()

C4StartupModsLocalModDiscovery::C4StartupModsLocalModDiscovery ( C4StartupModsDlg *  parent )

inline

Definition at line 76 of file C4StartupModsDlg.h.

                                                             :
        discoveryFinishedEvent(true),
        parent(parent)
    {
        StdThread::Start();
    }

References StdThread::Start().

Here is the call graph for this function:

Member Function Documentation

AddMod()

ModsInfo& C4StartupModsLocalModDiscovery::AddMod ( const std::string &  id, const std::string &  path, const std::string &  name  )

inline

Definition at line 111 of file C4StartupModsDlg.h.

    {
        CStdLock lock(&modInformationModification);
        modsInformation[id] = ModsInfo{ id, path, name };
        return modsInformation[id];
    }

Execute()

void C4StartupModsLocalModDiscovery::Execute ( )

overrideprotectedvirtual

Implements StdThread.

Definition at line 482 of file C4StartupModsDlg.cpp.

{
    assert(!discoveryFinished);
    discoveryFinishedEvent.Reset();
 
    ExecuteDiscovery();
 
    discoveryFinished = true;
    discoveryFinishedEvent.Set();
 
    parent->QueueSyncWithDiscovery();
 
    StdThread::SignalStop();
}

References C4StartupModsDlg::QueueSyncWithDiscovery(), CStdEvent::Reset(), CStdEvent::Set(), and StdThread::SignalStop().

Here is the call graph for this function:

GetAllModInformation()

const std::map<std::string, ModsInfo>& C4StartupModsLocalModDiscovery::GetAllModInformation ( )

inline

Definition at line 119 of file C4StartupModsDlg.h.

    {
        return modsInformation;
    }

GetModInformation()

ModsInfo C4StartupModsLocalModDiscovery::GetModInformation ( const std::string &  id )

inline

Definition at line 100 of file C4StartupModsDlg.h.

    {
        CStdLock lock(&modInformationModification);
        assert(IsDiscoveryFinished());
        return modsInformation[id];
    }

References IsDiscoveryFinished().

Here is the call graph for this function:

IsDiscoveryFinished()

bool C4StartupModsLocalModDiscovery::IsDiscoveryFinished ( ) const

inline

Definition at line 91 of file C4StartupModsDlg.h.

{ return discoveryFinished; }

Referenced by GetModInformation(), and IsModInstalled().

Here is the caller graph for this function:

IsModInstalled()

const bool C4StartupModsLocalModDiscovery::IsModInstalled ( const std::string &  id )

inline

Definition at line 94 of file C4StartupModsDlg.h.

    {
        CStdLock lock(&modInformationModification);
        assert(IsDiscoveryFinished());
        return modsInformation.count(id) != 0;
    }

References IsDiscoveryFinished().

Here is the call graph for this function:

IsSelfDestruct()

virtual bool StdThread::IsSelfDestruct ( )

inlineprotectedvirtualinherited

Reimplemented in CPNGSaveThread.

Definition at line 338 of file StdScheduler.h.

{ return false; } // whether thread should delete itself after execution finished

IsStarted()

bool StdThread::IsStarted ( )

inlineinherited

Definition at line 332 of file StdScheduler.h.

{ return fStarted; }

IsStopSignaled()

bool StdThread::IsStopSignaled ( )

protectedinherited

Definition at line 342 of file StdScheduler.cpp.

{
    return fStopSignaled;
}

Lock()

CStdLock C4StartupModsLocalModDiscovery::Lock ( )

inline

Definition at line 123 of file C4StartupModsDlg.h.

    {
        return std::move(CStdLock(&modInformationModification));
    }

RemoveMod()

void C4StartupModsLocalModDiscovery::RemoveMod ( const std::string &  id )

inline

Definition at line 106 of file C4StartupModsDlg.h.

    {
        CStdLock lock(&modInformationModification);
        modsInformation.erase(id);
    }

SignalStop()

void StdThread::SignalStop ( )

inherited

Definition at line 298 of file StdScheduler.cpp.

{
    // Not running?
    if (!fStarted) return;
    // Set flag
    fStopSignaled = true;
}

Referenced by CPNGSaveThread::Execute(), Execute(), and C4StartupModsDownloader::ModInfo::LocalDiscoveryCheck::Execute().

Here is the caller graph for this function:

Start()

bool StdThread::Start ( )

inherited

Definition at line 282 of file StdScheduler.cpp.

{
    // already running? stop
    if (fStarted) Stop();
    // begin thread
    fStopSignaled = false;
#ifdef HAVE_WINTHREAD
    iThread = _beginthread(_ThreadFunc, 0, this);
    fStarted = (iThread != -1);
#elif defined(HAVE_PTHREAD)
    fStarted = !pthread_create(&Thread, nullptr, _ThreadFunc, this);
#endif
    // success?
    return fStarted;
}

References StdThread::Stop().

Referenced by C4StartupModsLocalModDiscovery(), CPNGFile::ScheduleSaving(), and C4StartupModsDownloader::ModInfo::LocalDiscoveryCheck::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

Stop()

void StdThread::Stop ( )

inherited

Definition at line 306 of file StdScheduler.cpp.

{
    // Not running?
    if (!fStarted) return;
    // Set flag
    fStopSignaled = true;
#ifdef HAVE_WINTHREAD
    // Wait for thread to terminate itself
    HANDLE hThread = reinterpret_cast<HANDLE>(iThread);
    if (WaitForSingleObject(hThread, 10000) == WAIT_TIMEOUT)
        // ... or kill it in case it refuses to do so
        TerminateThread(hThread, -1);
#elif defined(HAVE_PTHREAD)
    // wait for thread to terminate itself
    // (whithout security - let's trust these unwashed hackers for once)
    pthread_join(Thread, nullptr);
#endif
    fStarted = false;
    // ok
    return;
}

Referenced by StdThread::Start(), and StdThread::~StdThread().

Here is the caller graph for this function:

WaitForDiscoveryFinished()

void C4StartupModsLocalModDiscovery::WaitForDiscoveryFinished ( )

inline

Definition at line 92 of file C4StartupModsDlg.h.

{ discoveryFinishedEvent.WaitFor(-1); }

References CStdEvent::WaitFor().

Here is the call graph for this function:

---

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

• C4StartupModsDlg.h
• C4StartupModsDlg.cpp