API Documentation
Loading...
Searching...
No Matches
Thread Class Reference

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

#include <Thread.h>

Inheritance diagram for Thread:
[legend]

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 StringthreadName () const
 
virtual ~Thread ()
 

Static Public Member Functions

static ThreadCurrentThread ()
 
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 ()
 

Static Protected Member Functions

static void _setThreadName (const String &name)
 
static uint08 GetThreadCount ()
 

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.


autotoc_md585

Constructor & Destructor Documentation

◆ Thread() [1/3]

Thread ( )

◆ Thread() [2/3]

Thread ( const String & name)

◆ Thread() [3/3]

Thread ( const Thread & name)
delete

◆ ~Thread()

~Thread ( )
virtual

Member Function Documentation

◆ _setThreadName()

void _setThreadName ( const String & name)
staticprotected

◆ CurrentThread()

Thread & CurrentThread ( )
static

◆ CurrentThreadName()

String CurrentThreadName ( )
static

◆ detach()

void detach ( )

◆ forceStop()

void forceStop ( )
inline

◆ GetThreadCount()

static uint08 GetThreadCount ( )
inlinestaticprotected

◆ isPrimaryThread()

bool isPrimaryThread ( ) const

◆ isRunning()

bool isRunning ( ) const

◆ join()

void join ( )

◆ requestStopThread()

void requestStopThread ( )
virtual

◆ run()

virtual void run ( )
inlineprotectedvirtual

◆ self()

const std::thread & self ( )
protected

◆ ServiceVirtualThreads()

void ServiceVirtualThreads ( )
static

◆ SetCurrentThreadName()

void SetCurrentThreadName ( const String & name)
static

◆ setIsPrimaryThread()

void setIsPrimaryThread ( bool is_primary_thread)

◆ setThreadName()

void setThreadName ( const String & name)

◆ shouldExitThread()

bool shouldExitThread ( ) const
virtual

◆ start()

void start ( )

◆ StopAllThreads()

void StopAllThreads ( )
static

◆ stopThread()

void stopThread ( )
virtual

Reimplemented in AsciiWriteThread, and 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 files: