This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::Thread Class

Unigine Thread.

To use this class, include the UnigineThread.h file.

Unigine::Thread Class

Members


Thread ()

Constructor.

virtual ~Thread ()

Virtual destructor.

int run (size_t size)

Runs the thread.

Arguments

  • size_t size - Thread stack size in bytes.

Return value

Returns 1 if the thread was successfully run; otherwise, 0 is returned.

int stop ()

Stops the thread.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

int signal ()

Signals the thread.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

int terminate ()

Terminates the thread.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

int isRunning () const

Checks if the thread is running.

Return value

Returns 1 if the thread is running; otherwise, 0 is returned.

int isWaiting () const

Checks if the thread is waiting.

Return value

Returns 1 if the thread is waiting; otherwise, 0 is returned.

int setPriority (int priority)

Sets the thread priority.

Arguments

  • int priority - Thread priority to set in range [-3;3]. The default thread priority is 0.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

int getPriority () const

Gets the thread priority.

Return value

Returns the thread priority in range [-3;3].

static int getID ()

Returns the current thread identifier.

Return value

The unique thread identifier.

virtual void process () =0

Thread process function.

void usleep (unsigned int usec)

Suspends thread execution in microseconds.

Arguments

  • unsigned int usec - Time in microseconds.

void wait ()

Puts the thread into the waiting state.
Last update: 2017-07-03
Build: ()