xiiRemoteThread Class Reference

The remote interface thread updates in regular intervals to keep the connection alive. More...

#include <RemoteInterface.h>

Inheritance diagram for xiiRemoteThread:

Public Attributes
xiiRemoteInterface *	m_pRemoteInterface = nullptr
volatile bool	m_bKeepRunning = true

Private Member Functions
virtual xiiUInt32	Run ()
	The run function can be used to implement a long running task in a thread in a platform independent way.

Additional Inherited Members
Public Types inherited from xiiThread
enum	xiiThreadStatus { Created = 0 , Running , Finished }
	Describes the thread status.
Public Member Functions inherited from xiiThread
	xiiThread (xiiStringView sName="xiiThread", xiiUInt32 uiStackSize=128 *1024)
	Initializes the runnable class.
virtual	~xiiThread ()
	Destructor checks if the thread is deleted while still running, which is not allowed as this is a data hazard.
xiiThreadStatus	GetThreadStatus () const
	Returns the thread status.
bool	IsRunning () const
	Helper function to determine if the thread is running.
xiiStringView	GetThreadName () const
	Returns the thread name.
Public Member Functions inherited from xiiOSThread
	xiiOSThread (xiiOSThreadEntryPoint threadEntryPoint, void *pUserData=nullptr, xiiStringView sName="xiiOSThread", xiiUInt32 uiStackSize=128 *1024)
	Initializes the thread instance (e.g. thread creation etc.)
virtual	~xiiOSThread ()
	Destructor.
void	Start ()
	Starts the thread.
void	Join ()
	Waits in the calling thread until the thread has finished execution (e.g. returned from the thread function)
const xiiThreadID &	GetThreadID () const
	Returns the thread ID of the thread object, may be used in comparison operations with xiiThreadUtils::GetCurrentThreadID() for example.
Static Public Member Functions inherited from xiiThread
static const xiiThread *	GetCurrentThread ()
	Returns the current xiiThread if the current platform thread is a xiiThread. Returns nullptr otherwise.
Static Public Member Functions inherited from xiiOSThread
static xiiInt32	GetThreadCount ()
	Returns how many xiiOSThreads are currently active.
Static Public Attributes inherited from xiiThread
static xiiEvent< const xiiThreadEvent &, xiiMutex >	s_ThreadEvents
	These events inform about threads starting and finishing.
Protected Attributes inherited from xiiOSThread
xiiThreadHandle	m_hHandle
xiiThreadID	m_ThreadID
xiiOSThreadEntryPoint	m_EntryPoint
void *	m_pUserData
xiiString	m_sName
xiiUInt32	m_uiStackSize

Detailed Description

The remote interface thread updates in regular intervals to keep the connection alive.

The thread does NOT call xiiRemoteInterface::ExecuteAllMessageHandlers(), so by default no message handlers are executed. This has to be done manually by the application elsewhere.

Member Function Documentation

Run()

xiiUInt32 xiiRemoteThread::Run ( )

privatevirtual

The run function can be used to implement a long running task in a thread in a platform independent way.

Implements xiiThread.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Communication/RemoteInterface.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Communication/Implementation/RemoteInterface.cpp