Sdk thread api documentation

Thread functions.

Functions

dmThread::AllocTls

 dmThread::AllocTls()

Allocate thread local storage key

PARAMETERS

RETURNS

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

dmThread::FreeTls

void dmThread::FreeTls( key)

Free thread local storage key

PARAMETERS

dmThread::GetCurrentThread

 dmThread::GetCurrentThread()

Gets the current thread

PARAMETERS

RETURNS

dmThread::GetTlsValue

void dmThread::GetTlsValue( key)

Get thread specific data

PARAMETERS

dmThread::Join

void dmThread::Join( thread)

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

dmThread::New

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

Create a new named thread

PARAMETERS

RETURNS

EXAMPLES

#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);
}

dmThread::SetThreadName

void dmThread::SetThreadName( thread,  name)

Sets the current thread name

PARAMETERS

dmThread::SetTlsValue

void dmThread::SetTlsValue( key,  value)

Set thread specific data

PARAMETERS