Thread Class Reference

A thread is a single sequence stream within the software. More...

#include <Thread.h>

Inheritance diagram for Thread:

Public Member Functions
void	detach ()
void	forceStop ()
bool	isPrimaryThread () const
bool	isRunning () const
void	join ()
virtual void	requestStopThread ()
void	setIsPrimaryThread (bool is_primary_thread)
void	setThreadName (const String &name)
virtual bool	shouldExitThread () const
void	start ()
virtual void	stopThread ()
	Thread ()
	Thread (const String &name)
	Thread (const Thread &name)=delete
const String &	threadName () const
virtual	~Thread ()

Static Public Member Functions
static Thread &	CurrentThread ()
static String	CurrentThreadName ()
static void	ServiceVirtualThreads ()
static void	SetCurrentThreadName (const String &name)
static void	StopAllThreads ()

Protected Member Functions
virtual void	run ()
const std::thread &	self ()

Protected Attributes
volatile bool	m_is_running = false
volatile bool	m_is_single_run = true

Detailed Description

A thread is a single sequence stream within the software.

---

This is the default Thread class for the NDEVR API

Constructor & Destructor Documentation

Thread() [1/3]

Thread

(

)

Thread() [2/3]

Thread

(

const String &

name

)

Thread() [3/3]

Thread ( const Thread & name )

delete

~Thread()

virtual ~Thread ( )

virtual

Member Function Documentation

CurrentThread()

static Thread & CurrentThread ( )

static

CurrentThreadName()

static String CurrentThreadName ( )

static

detach()

void detach

(

)

forceStop()

void forceStop ( )

inline

isPrimaryThread()

bool isPrimaryThread

(

)

const

isRunning()

bool isRunning

(

)

const

join()

void join

(

)

requestStopThread()

virtual void requestStopThread ( )

virtual

run()

virtual void run ( )

inlineprotectedvirtual

Reimplemented in BasicThread, CachedFactoryIOThread, and ThreadQueue.

self()

const std::thread & self ( )

protected

ServiceVirtualThreads()

static void ServiceVirtualThreads ( )

static

SetCurrentThreadName()

static void SetCurrentThreadName ( const String & name )

static

setIsPrimaryThread()

void setIsPrimaryThread

(

bool

is_primary_thread

)

setThreadName()

void setThreadName

(

const String &

name

)

shouldExitThread()

virtual bool shouldExitThread ( ) const

virtual

start()

void start

(

)

StopAllThreads()

static void StopAllThreads ( )

static

stopThread()

virtual void stopThread ( )

virtual

Reimplemented in CachedFactoryIOThread.

threadName()

const String & threadName ( ) const

inline

Member Data Documentation

m_is_running

volatile bool m_is_running = false

protected

m_is_single_run

volatile bool m_is_single_run = true

protected

---

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

• Base/Headers/Thread.h