ramses::IThreadWatchdogNotification Class Reference

#include <IThreadWatchdogNotification.h>

Public Member Functions
virtual	~IThreadWatchdogNotification ()=default
virtual void	notifyThread (ERamsesThreadIdentifier threadID)=0
virtual void	registerThread (ERamsesThreadIdentifier threadID)=0
virtual void	unregisterThread (ERamsesThreadIdentifier threadID)=0

Detailed Description

Users can implement this callback to receive alive notifications about ramses threads.

In order to receive alive notification of ramses threads, one must provide a pointer to an implementation of this interface to RamsesFrameworkConfig::setWatchdogNotificationCallBack Before calling notifyThread with a certain threadID a registerThread call for that id will be invoked. Before stopping notifications of a certain threadID the unregisterThread method will be invoked - therefore do not expect alive messages for a certain threadID after an unregisterThread call for that threadID.

Constructor & Destructor Documentation

~IThreadWatchdogNotification()

virtual ramses::IThreadWatchdogNotification::~IThreadWatchdogNotification ( )

virtualdefault

Virtual destructor of IThreadWatchdogNotification

Member Function Documentation

notifyThread()

virtual void ramses::IThreadWatchdogNotification::notifyThread ( ERamsesThreadIdentifier  threadID )

pure virtual

This method is invoked cyclic with threadID of alive threads.

The method is invoked from the actual thread context in question, therefore users must take care not to call long operations in this callback, or ramses processing will be blocked.

Parameters

[in]

threadID

ID of thread reporting it being alive.

registerThread()

virtual void ramses::IThreadWatchdogNotification::registerThread ( ERamsesThreadIdentifier  threadID )

pure virtual

Before reporting alive messages of a certain threadID, this method will be called with that specific threadID. Do not expect notifyThread calls for threadID before this method was invoked.

Parameters

[in]

threadID

ID of thread that will be reported.

unregisterThread()

virtual void ramses::IThreadWatchdogNotification::unregisterThread ( ERamsesThreadIdentifier  threadID )

pure virtual

Before stopping to report alive messages of a certain threadID, this method will be called with that specific threadID. Do not expect notifyThread calls for threadID after this method was invoked.

Parameters

[in]

threadID

ID of thread that will not report anymore.

---

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

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/IThreadWatchdogNotification.h