Thread Struct Reference

#include <evo/thread.h>

Inheritance diagram for Thread:

Detailed Description

Manages a single thread of execution.

• This implements a function-based thread handler, and serves as a common thread interface
• Function-based thread:
  • Caller provides a thread function and an optional pointer argument
  • May be detached to run in the background
• See ThreadClass for a class-based thread, preferred with threads that share state
  • Note that this (Thread) is the real base class for all Evo threads, while ThreadClass is the base class for class-based threads
• See also ThreadScope<Thread> for creating a simple scoped thread, and ThreadGroup for creating a group of threads
• Linking:
  • Linux/Unix: -pthread
  • Cygwin: -lpthread
  • Windows: Usually multithreaded by default – MSVC project settings: C/C++ -> Code Generation -> Runtime Library

Example

#include <evo/thread.h>
using namespace evo;

static void thread_run(void* arg) {
    // Thread code
}

int main() {
    Thread thread(thread_run, NULL);
    thread.thread_start();
    thread.thread_join();
    return 0;
}

Classes
struct	Init
	Initialization structure for starting a function-based thread. More...

Public Types
typedef std::function< void(void *)>	Func
	Thread function type – with C++11 supports lambda/functor, otherwise just function pointer More...

Public Member Functions
	Thread ()
	Constructor. More...
	Thread (Func func, void *arg=NULL)
	Constructor for function-based thread. More...
	Thread (const Init &init)
	Constructor for function-based thread. More...
virtual	~Thread ()
	Destructor. More...
bool	thread_active () const
	Get whether thread is active (running). More...
virtual bool	thread_detach ()
	Detach thread to run in background. More...
SysThread::Handle	thread_handle () const
	Get platform-specific thread handle. More...
bool	thread_join ()
	Join thread by waiting for thread to stop. More...
bool	thread_start ()
	Start thread. More...

Static Public Member Functions
static ulong	id ()
	Get current thread ID from system. More...
static void	yield ()
	Yield control to another thread or process. More...

Public Attributes
Init	thread_init
	Thread function pointer More...

Protected Attributes
bool	thread_active_
SysThread	thread_impl_

Member Typedef Documentation

Func

typedef std::function<void (void*)> Func

Thread function type – with C++11 supports lambda/functor, otherwise just function pointer

Constructor & Destructor Documentation

Thread() [1/3]

Thread ( )

inline

Constructor.

Thread() [2/3]

Thread ( Func  func, void *  arg = NULL  )

inline

Constructor for function-based thread.

Parameters

func	Thread function pointer
arg	Argument to pass to thread function

Thread() [3/3]

Thread ( const Init &  init )

inline

Constructor for function-based thread.

Parameters

init	Initialization data for thread

~Thread()

virtual ~Thread ( )

inlinevirtual

Destructor.

• Calls thread_join() to wait for thread to stop, if active
• WARNING: Class-based threads must be stopped already – see ThreadClass

Member Function Documentation

id()

static ulong id ( )

inlinestatic

Get current thread ID from system.

Returns

Current thread ID

thread_active()

bool thread_active ( ) const

inline

Get whether thread is active (running).

• This gets whether the thread was started but hasn't been joined yet – the thread may have terminated though

Returns

Whether active, true if thread has started and hasn't been joined yet

thread_detach()

virtual bool thread_detach ( )

inlinevirtual

Detach thread to run in background.

• The thread will continue running and will no longer be joinable or accessible
• Start a new thread with thread_start()

thread_handle()

SysThread::Handle thread_handle ( ) const

inline

Get platform-specific thread handle.

Returns

Thread handle

thread_join()

bool thread_join ( )

inline

Join thread by waiting for thread to stop.

• Class-based thread: May need to call thread_cancel() and wake the thread first, depending on thread implementation

Returns

Whether successful, false on error (out of memory/resources) or if thread not started

thread_start()

bool thread_start ( )

inline

Start thread.

• The thread will start immediately, possibly even before this returns

Returns

Whether successful, false on error (out of memory/resources or thread_init.func=NULL)

yield()

static void yield ( )

inlinestatic

Yield control to another thread or process.

Member Data Documentation

thread_active_

bool thread_active_

protected

thread_impl_

SysThread thread_impl_

protected

thread_init

Init thread_init

Thread function pointer

---

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

• evo/thread.h