API reference (dmThread)

Extension

Lua

Defold

Version

Sdk thread api documentation

Thread functions.


Namespace:	`dmThread`
Include:	`#include <dmsdk/dlib/thread.h>`

FUNCTIONS
dmThread::New( thread_start, stack_size, arg, name)	create a new thread
void dmThread::Join( thread)	join thread
void dmThread::Detach( thread)	detach thread
dmThread::AllocTls()	allocate thread local storage key
void dmThread::FreeTls( key)	free thread local storage key
void dmThread::SetTlsValue( key, value)	set thread specific data
void dmThread::GetTlsValue( key)	get thread specific data
dmThread::GetCurrentThread()	gets the current thread
void dmThread::SetThreadName( thread, name)	sets the current thread name

Functions

dmThread::New

dmThread::New( thread_start, stack_size, arg, name)

Create a new named thread

PARAMETERS

	`thread_start`	Thread entry function
	`stack_size`	Stack size
	`arg`	Thread argument
	`name`	Thread name

RETURNS

handle

EXAMPLES

Create a thread

#include <stdio.h>
#include <dmsdk/dlib/thread.h>

struct Context
{
    bool m_DoWork;
    int  m_Work;
};

static void Worker(void* _ctx)
{
    Context* ctx = (Context*)_ctx;
    while (ctx->m_DoWork)
    {
        ctx->m_Work++; // do work
        dmTime::Sleep(10*1000); // yield
    }
}

int StartThread()
{
    Context ctx;
    ctx.m_DoWork = true;
    ctx.m_Work = 0;
    dmThread::Thread thread = dmThread::New(Worker, 0x80000, (void*)&ctx, "my_thread");

    // do other work...
    // ..eventually stop the thread:
    ctx.m_DoWork = false;

    // wait for thread
    dmThread::Join(thread);

    printf("work done: %d\n", ctx.m_Work);
}

Join thread. Waits for the thread specified by thread to terminate. If that thread has already terminated, then Join() returns immediately. The thread specified by thread must be joinable (see Detach()).

PARAMETERS

thread Thread to join

dmThread::Detach

void dmThread::Detach( thread)

Detach thread. When a detached thread terminates, its resources are automatically released back to the system without the need for another thread to join with the terminated thread.

PARAMETERS

thread Thread to detach