Static Public Member Functions

MThreadAsync Class Reference

This reference page is linked to from the following overview topics: Threading and Maya, API Classes and plug-ins, Threading and Maya API.


Search for all occurrences

Detailed Description

Methods for creating threads.

MThreadAsync class. Allows creation of asynchronous threads.

#include <MThreadAsync.h>

List of all members.

Static Public Member Functions

static MStatus init ()
 Initialize asynchronous thread creation mechanism.
static MStatus createTask (MThreadFunc func, void *data, MThreadAsyncCallbackFunc afunc, MThreadRootTask *root)
 Create a single task.
static void release ()
 This function decreases the reference count on the class.
static const char * className ()
 Returns the name of this class.

Member Function Documentation

MStatus init ( ) [static]

Initialize asynchronous thread creation mechanism.

No threads are created by this call. Each call to init increases a reference count on the class, each call to release() reduces the reference count. When the reference count reaches zero the threads are deleted.

Returns:
Examples:
threadTestWithLocksCmd.cpp.
MStatus createTask ( MThreadFunc  func,
void *  data,
MThreadAsyncCallbackFunc  afunc,
MThreadRootTask *  root 
) [static]

Create a single task.

createMapping must have been called before calling this method.

Parameters:
[in]funcpointer to function to be executed by threads
[in]datadata for function
[in]afuncpointer to callback function to be executed by threads
[in]rootroot task
Returns:
Examples:
threadTestWithLocksCmd.cpp.
void release ( ) [static]

This function decreases the reference count on the class.

When the reference count reaches zero the threads are deleted.

Examples:
threadTestWithLocksCmd.cpp.
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync
MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync MThreadAsync