Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

VXItrd.h File Reference

#include "VXItypes.h"
#include "VXIheaderPrefix.h"
#include "VXIheaderSuffix.h"

Defines

#define VXITRD_API   SYMBOL_IMPORT_DECL
#define VXITRD_DEFINE_THREAD_FUNC(funcName, userData)   VXItrdThreadArg funcName(VXItrdThreadArg userData)

Typedefs

typedef VXItrdThreadArg(* VXItrdThreadStartFunc )(VXItrdThreadArg userData)
typedef enum VXItrdResult VXItrdResult
 Result codes for functions.

Enumerations

enum  VXItrdResult {
  VXItrd_RESULT_FATAL_ERROR = -100, VXItrd_RESULT_IO_ERROR = -8, VXItrd_RESULT_OUT_OF_MEMORY = -7, VXItrd_RESULT_SYSTEM_ERROR = -6,
  VXItrd_RESULT_PLATFORM_ERROR = -5, VXItrd_RESULT_BUFFER_TOO_SMALL = -4, VXItrd_RESULT_INVALID_PROP_NAME = -3, VXItrd_RESULT_INVALID_PROP_VALUE = -2,
  VXItrd_RESULT_INVALID_ARGUMENT = -1, VXItrd_RESULT_SUCCESS = 0, VXItrd_RESULT_FAILURE = 1, VXItrd_RESULT_NON_FATAL_ERROR = 2,
  VXItrd_RESULT_UNSUPPORTED = 100
}
 Result codes for functions. More...

Functions

VXITRD_API VXItrdResult VXItrdMutexCreate (VXItrdMutex **mutex)
 Create a mutex.
VXITRD_API VXItrdResult VXItrdMutexDestroy (VXItrdMutex **mutex)
 Destroy a mutex.
VXITRD_API VXItrdResult VXItrdMutexLock (VXItrdMutex *mutex)
 Lock a mutex.
VXITRD_API VXItrdResult VXItrdMutexUnlock (VXItrdMutex *mutex)
 Unlock a Mutex.
VXITRD_API VXItrdResult VXItrdThreadCreate (VXItrdThread **thread, VXItrdThreadStartFunc startFunc, VXItrdThreadArg arg)
 Create a thread.
VXITRD_API VXItrdResult VXItrdThreadDestroyHandle (VXItrdThread **thread)
 Destroy a thread handle.
VXITRD_API void VXItrdThreadExit (VXItrdThreadArg status)
 Terminate a thread (called by the thread to exit).
VXITRD_API VXItrdResult VXItrdThreadJoin (VXItrdThread *thread, VXItrdThreadArg *status, long timeout)
 Wait for the termination of a specified thread.
VXITRD_API VXIthreadID VXItrdThreadGetIDFromHandle (VXItrdThread *thread)
 Get the thread ID for the specified thread.
VXITRD_API VXIthreadID VXItrdThreadGetID (void)
 Get the thread ID for the current thread.
VXITRD_API void VXItrdThreadYield (void)
 Yield execution of the current thread to other threads/processes.
VXITRD_API VXItrdResult VXItrdTimerCreate (VXItrdTimer **timer)
 Create a timer.
VXITRD_API VXItrdResult VXItrdTimerDestroy (VXItrdTimer **timer)
 Destroy a timer.
VXITRD_API VXItrdResult VXItrdTimerSleep (VXItrdTimer *timer, VXIint sleepMs, VXIbool *interrupted)
 Suspend the current thread for a time period using a timer.
VXITRD_API VXItrdResult VXItrdTimerWake (VXItrdTimer *timer)
 Wakes a thread that is sleeping on a timer.
VXITRD_API VXItrdResult VXItrdInit (VXIint32 threadStackSize)
 Initialize the TRD utilities library.
VXITRD_API VXItrdResult VXItrdShutDown (void)
 Shutdown the TRD utilities library.

Variables

*typedef void * VXItrdThreadArg
 Function signature invoked on the new thread by VXItrdThreadCreate( ), and the argument to that function.


Define Documentation

#define VXITRD_API   SYMBOL_IMPORT_DECL
 


Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2