C4InteractiveThread Class Reference

#include <C4InteractiveThread.h>

Inheritance diagram for C4InteractiveThread:

Classes
class	Callback

Public Member Functions
	C4InteractiveThread ()
	~C4InteractiveThread ()
bool	AddProc (StdSchedulerProc *pProc)
void	RemoveProc (StdSchedulerProc *pProc)
bool	PushEvent (C4InteractiveEventType eEventType, void *pData=nullptr)
void	ProcessEvents ()
bool	ThreadLog (const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
bool	ThreadLogFatal (const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
bool	ThreadLogS (const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
bool	ThreadLogDebug (const char *szMessage,...) GNUC_FORMAT_ATTRIBUTE_O
template<typename RType = void, typename Functor >
bool	ThreadPostAsync (Functor function)
void	SetCallback (C4InteractiveEventType eEvent, Callback *pnNetworkCallback)
void	ClearCallback (C4InteractiveEventType eEvent, Callback *pnNetworkCallback)

Detailed Description

Definition at line 59 of file C4InteractiveThread.h.

Constructor & Destructor Documentation

C4InteractiveThread()

C4InteractiveThread::C4InteractiveThread

(

)

Definition at line 23 of file C4InteractiveThread.cpp.

{
    // Add head-item
    pFirstEvent = pLastEvent = new Event();
    pFirstEvent->Type = Ev_None;
    pFirstEvent->Next = nullptr;
    // reset event handlers
    ZeroMem(&pCallbacks, sizeof(pCallbacks));
    // Set notify proc
    NotifyProc.SetNotify(this);
    Application.Add(&NotifyProc);
}

References StdScheduler::Add(), Application, Ev_None, C4InteractiveThreadNotifyProc::SetNotify(), and ZeroMem().

Here is the call graph for this function:

~C4InteractiveThread()

C4InteractiveThread::~C4InteractiveThread

(

)

Definition at line 36 of file C4InteractiveThread.cpp.

{
    CStdLock PushLock(&EventPushCSec), PopLock(&EventPopCSec);
    // Remove all items. This may leak data, if pData was allocated on the heap.
    while (PopEvent(nullptr, nullptr)) {}
    // Delete head-item
    delete pFirstEvent;
    pFirstEvent = pLastEvent = nullptr;
    // Unregister notify
    Application.Remove(&NotifyProc);
}

References Application, and StdScheduler::Remove().

Here is the call graph for this function:

Member Function Documentation

AddProc()

bool C4InteractiveThread::AddProc

(

StdSchedulerProc *

pProc

)

Definition at line 48 of file C4InteractiveThread.cpp.

{
    bool fFirst = !Scheduler.getProcCnt();
    // Add the proc
    Scheduler.Add(pProc);
    // Not started yet?
    if (fFirst)
        if (!Scheduler.Start())
            return false;
    return true;
}

References StdSchedulerThread::Add(), StdScheduler::getProcCnt(), and StdSchedulerThread::Start().

Referenced by C4StartupNetDlg::CheckVersionUpdate(), C4Network2IO::Init(), C4ChatControl::OnConnectBtn(), and C4StartupNetListEntry::SetRefQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearCallback()

void C4InteractiveThread::ClearCallback ( C4InteractiveEventType  eEvent, Callback *  pnNetworkCallback  )

inline

Definition at line 122 of file C4InteractiveThread.h.

    { if (pCallbacks[eEvent] == pnNetworkCallback) pCallbacks[eEvent] = nullptr; }

Referenced by C4Network2IO::Clear(), C4Network2IO::Init(), C4ChatControl::~C4ChatControl(), C4StartupModsDlg::~C4StartupModsDlg(), and C4StartupNetDlg::~C4StartupNetDlg().

Here is the caller graph for this function:

ProcessEvents()

void C4InteractiveThread::ProcessEvents

(

)

Definition at line 121 of file C4InteractiveThread.cpp.

{
    C4InteractiveEventType eEventType; void *pEventData;
    while (PopEvent(&eEventType, &pEventData))
        switch (eEventType)
        {
            // Logging
        case Ev_Log: case Ev_LogSilent: case Ev_LogFatal: case Ev_LogDebug:
        {
            // Reconstruct the StdStrBuf which allocated the data.
            StdStrBuf pLog;
            pLog.Take(reinterpret_cast<char *>(pEventData));
            switch (eEventType)
            {
            case Ev_Log:
                Log(pLog.getData()); break;
            case Ev_LogSilent:
                LogSilent(pLog.getData()); break;
            case Ev_LogFatal:
                LogFatal(pLog.getData()); break;
            case Ev_LogDebug:
                DebugLog(pLog.getData()); break;
            default: assert(eEventType == Ev_Log || eEventType == Ev_LogSilent || eEventType == Ev_LogFatal || eEventType == Ev_LogDebug); // obviously will not happen, but someone tell gcc
            }
 
        }
        break;
 
    case Ev_Function:
        {
            std::unique_ptr<std::function<void ()> > func(static_cast<std::function<void()>*>(pEventData));
            (*func)();
        }
 
        // Other events: check for a registered handler
        default:
            if (eEventType >= Ev_None && eEventType <= Ev_Last)
                if (pCallbacks[eEventType])
                    pCallbacks[eEventType]->OnThreadEvent(eEventType, pEventData);
            // Note that memory might leak if the event wasn't processed....
        }
}

References DebugLog(), Ev_Function, Ev_Last, Ev_Log, Ev_LogDebug, Ev_LogFatal, Ev_LogSilent, Ev_None, StdStrBuf::getData(), Log(), LogFatal(), LogSilent(), C4InteractiveThread::Callback::OnThreadEvent(), and StdStrBuf::Take().

Referenced by C4Network2IO::Clear(), C4InteractiveThreadNotifyProc::Execute(), and C4Network2UPnPP::~C4Network2UPnPP().

Here is the call graph for this function:

Here is the caller graph for this function:

PushEvent()

bool C4InteractiveThread::PushEvent	(	C4InteractiveEventType	eEventType,
		void *	pData = nullptr
	)

Definition at line 72 of file C4InteractiveThread.cpp.

{
    CStdLock PushLock(&EventPushCSec);
    if (!pLastEvent) return false;
    // create event
    Event *pEvent = new Event;
    pEvent->Type = eEvent;
    pEvent->Data = pData;
#ifdef _DEBUG
    pEvent->Time = C4TimeMilliseconds::Now();
#endif
    pEvent->Next = nullptr;
    // add item (at end)
    pLastEvent->Next = pEvent;
    pLastEvent = pEvent;
    PushLock.Clear();
    // notify main thread
    NotifyProc.Notify();
    return true;
}

References CStdLock::Clear(), CStdNotifyProc::Notify(), and C4TimeMilliseconds::Now().

Referenced by C4HTTPClient::Execute(), C4Network2IO::HandlePacket(), C4Network2IO::OnDisconn(), ThreadLog(), ThreadLogDebug(), ThreadLogFatal(), ThreadLogS(), and ThreadPostAsync().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveProc()

void C4InteractiveThread::RemoveProc

(

StdSchedulerProc *

pProc

)

Definition at line 60 of file C4InteractiveThread.cpp.

{
    // Process not in list?
    if (!Scheduler.hasProc(pProc))
        return;
    // Last proc to be removed?
    if (Scheduler.getProcCnt() == 1)
        Scheduler.Stop();
    // Remove
    Scheduler.Remove(pProc);
}

References StdScheduler::getProcCnt(), StdScheduler::hasProc(), StdSchedulerThread::Remove(), and StdSchedulerThread::Stop().

Referenced by C4Network2IO::Clear(), C4StartupNetListEntry::ClearRef(), and C4StartupNetDlg::~C4StartupNetDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCallback()

void C4InteractiveThread::SetCallback ( C4InteractiveEventType  eEvent, Callback *  pnNetworkCallback  )

inline

Definition at line 120 of file C4InteractiveThread.h.

    { pCallbacks[eEvent] = pnNetworkCallback; }

Referenced by C4ChatControl::C4ChatControl(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupNetDlg::C4StartupNetDlg(), and C4Network2IO::Init().

Here is the caller graph for this function:

ThreadLog()

bool C4InteractiveThread::ThreadLog	(	const char *	szMessage,
			...
	)

Definition at line 165 of file C4InteractiveThread.cpp.

{
    // format message
    va_list lst; va_start(lst, szMessage);
    StdStrBuf Msg = FormatStringV(szMessage, lst);
    // send to main thread
    return PushEvent(Ev_Log, Msg.GrabPointer());
}

References Ev_Log, FormatStringV(), StdStrBuf::GrabPointer(), and PushEvent().

Referenced by C4Network2ResList::AddLoad(), C4GameControlNetwork::DoInput(), C4Network2IO::HandlePacket(), C4Network2IO::OnError(), and C4Network2IO::OnPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

ThreadLogDebug()

bool C4InteractiveThread::ThreadLogDebug	(	const char *	szMessage,
			...
	)

Definition at line 192 of file C4InteractiveThread.cpp.

{
    // format message
    va_list lst; va_start(lst, szMessage);
    StdStrBuf Msg = FormatStringV(szMessage, lst);
    // send to main thread
    return PushEvent(Ev_LogDebug, Msg.GrabPointer());
}

References Ev_LogDebug, FormatStringV(), StdStrBuf::GrabPointer(), and PushEvent().

Here is the call graph for this function:

ThreadLogFatal()

bool C4InteractiveThread::ThreadLogFatal	(	const char *	szMessage,
			...
	)

Definition at line 174 of file C4InteractiveThread.cpp.

{
    // format message
    va_list lst; va_start(lst, szMessage);
    StdStrBuf Msg = FormatStringV(szMessage, lst);
    // send to main thread
    return PushEvent(Ev_LogFatal, Msg.GrabPointer());
}

References Ev_LogFatal, FormatStringV(), StdStrBuf::GrabPointer(), and PushEvent().

Here is the call graph for this function:

ThreadLogS()

bool C4InteractiveThread::ThreadLogS	(	const char *	szMessage,
			...
	)

Definition at line 183 of file C4InteractiveThread.cpp.

{
    // format message
    va_list lst; va_start(lst, szMessage);
    StdStrBuf Msg = FormatStringV(szMessage, lst);
    // send to main thread
    return PushEvent(Ev_LogSilent, Msg.GrabPointer());
}

References Ev_LogSilent, FormatStringV(), StdStrBuf::GrabPointer(), and PushEvent().

Referenced by C4Network2ResList::AddByCore(), C4Network2ResList::AddLoad(), C4Network2ResChunk::AddTo(), C4GameControlNetwork::CheckCompleteCtrl(), C4Network2IO::CheckTimeout(), C4Network2Res::Derive(), C4Network2IO::HandlePacket(), C4Network2Res::OnChunk(), C4Network2IO::OnConn(), C4Network2IO::OnDisconn(), C4Network2IO::OnPacket(), C4Network2::OnPuncherConnect(), C4Network2ResList::OnResComplete(), C4Network2Res::SetLoad(), and C4Network2Res::StartLoad().

Here is the call graph for this function:

Here is the caller graph for this function:

ThreadPostAsync()

template<typename RType = void, typename Functor >

bool C4InteractiveThread::ThreadPostAsync ( Functor  function )

inline

Definition at line 114 of file C4InteractiveThread.h.

    {
        return PushEvent(Ev_Function, new std::function<RType()>(function));
    }

References Ev_Function, and PushEvent().

Referenced by C4Network2IRCClient::Join().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• C4InteractiveThread.h
• C4InteractiveThread.cpp