GblThread Struct Reference

#include <gimbal_thread.h>

Inheritance diagram for GblThread:

Data Fields
union {
GblThreadClass *   pClass
GblObject   base
};
GblCallRecord	returnStatus
volatile sig_atomic_t	signalStatus
GBL_THREAD_STATE	state
Data Fields inherited from GblObject
union {
GblObjectClass *   pClass
GblBox   base
};
Data Fields inherited from GblBox
union {
GblBoxClass *   pClass
GblInstance   base
};
struct {
GblArrayMap *   pFields
volatile uint16_t   refCounter
uint16_t   contextType: 1
uint16_t   constructedInPlace: 1
uint16_t   derivedFlags: 14
}	private_
Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
(Note that these are not member symbols.)
Parent Thread Methods
Methods to be called from a parent thread
#define	GblThread_create(...)
GblThread *	GblThread_ref (const GblThread *pSelf)
GblRefCount	GblThread_unref (GblThread *pSelf)
GblBool	GblThread_isJoined (const GblThread *pSelf)
const char *	GblThread_name (const GblThread *pSelf)
GBL_RESULT	GblThread_setName (GblThread *pSelf, const char *pName)
GblClosure *	GblThread_closure (const GblThread *pSelf)
void	GblThread_setClosure (GblThread *pSelf, GblClosure *pClosure)
GblThreadFn	GblThread_callback (const GblThread *pSelf)
void	GblThread_setCallback (GblThread *pSelf, GblThreadFn pCb)
GBL_RESULT	GblThread_setPriority (GblThread *pSelf, GBL_THREAD_PRIORITY priority)
GBL_RESULT	GblThread_setAffinity (GblThread *pSelf, GblThreadAffinity affinity)
GBL_RESULT	GblThread_start (GblThread *pSelf)
GBL_RESULT	GblThread_join (GblThread *pSelf)
GBL_RESULT	GblThread_spinWait (GblThread *pSelf)
Child Thread Methods
Methods to be called from the spawned child thread
GblThread *	GblThread_current (void)
GBL_RESULT	GblThread_yield (void)
#define	GblThread_nanoSleep(...)
#define	GblThread_exit(...)
Function Overload Macros
Macros providing default arguments for methods
#define	GblThread_create(...)
#define	GblThread_exit(...)
#define	GblThread_nanoSleep(...)
#define	GblThread_foreach(...)
Related Symbols inherited from GblObject
GblContext *	GblObject_findContext (GblObject *pSelf)
GBL_RESULT	GblObject_property (const GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)
GBL_RESULT	GblObject_propertyVaList (const GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_propertyVaListByQuark (const GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_propertyVariant (const GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)
GBL_RESULT	GblObject_propertiesVaList (const GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_propertiesVariants (const GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
GBL_RESULT	GblObject_setProperty (GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)
GBL_RESULT	GblObject_setPropertyVaList (GblObject *pSelf, const char *pName, va_list *pList)
GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject *pSelf, GblQuark name, va_list *pList)
GBL_RESULT	GblObject_setPropertyVariant (GblObject *pSelf, const char *pName, GblVariant *pValue)
GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject *pSelf, GblQuark name, GblVariant *pValue)
GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)
GBL_RESULT	GblObject_setPropertiesVaList (GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_setPropertiesVariants (GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
const GblStringRef *	GblObject_name (const GblObject *pSelf)
void	GblObject_setName (GblObject *pSelf, const char *pName)
void	GblObject_setNameRef (GblObject *pSelf, const GblStringRef *pRef)
GblObject *	GblObject_parent (const GblObject *pSelf)
void	GblObject_setParent (GblObject *pSelf, GblObject *pParent)
void	GblObject_addChild (GblObject *pSelf, GblObject *pChild)
GblBool	GblObject_removeChild (GblObject *pSelf, GblObject *pChild)
size_t	GblObject_depth (const GblObject *pSelf)
GblObject *	GblObject_childFirst (const GblObject *pSelf)
size_t	GblObject_childCount (const GblObject *pSelf)
GblObject *	GblObject_siblingNext (const GblObject *pSelf)
GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)
GblObject *	GblObject_findAncestorByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)
GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)
GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)
GblObject *	GblObject_findChildByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)
GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)
GblObject *	GblObject_findSiblingByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)
GBL_RESULT	GblObject_sendEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_notifyEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_installEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
GBL_RESULT	GblObject_uninstallEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
size_t	GblObject_eventFilterCount (const GblObject *pSelf)
GblIEventFilter *	GblObject_eventFilter (const GblObject *pSelf, size_t index)
Related Symbols inherited from GblBox
GblBox *	GblBox_ref (GblBox *pSelf)
GblRefCount	GblBox_unref (GblBox *pSelf)
GblRefCount	GblBox_refCount (const GblBox *pSelf)
void *	GblBox_userdata (const GblBox *pSelf)
GBL_RESULT	GblBox_setUserdata (GblBox *pSelf, void *pUserdata)
GBL_RESULT	GblBox_setUserDestructor (GblBox *pSelf, GblArrayMapDtorFn pFnUdDtor)
uintptr_t	GblBox_field (const GblBox *pSelf, GblQuark key)
uintptr_t	GblBox_takeField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_clearField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_hasField (const GblBox *pSelf, GblQuark key)
GBL_RESULT	GblBox_setField (GblBox *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
Related Symbols inherited from GblInstance
GblRefCount	GblInstance_destroy (GblInstance *pSelf)
#define	GBL_TYPEOF(self)
#define	GBL_PRIVATE(cType, self)
#define	GBL_PUBLIC(cType, selfPriv)
#define	GBL_TYPECHECK(cType, self)
#define	GBL_CAST(cType, self)
#define	GBL_AS(cType, self)
#define	GBL_CLASSOF(cType, self)
#define	GBL_CLASSOF_AS(cType, self)
#define	GBL_VCALL(cType, method, ...)
#define	GBL_VCALL_DEFAULT(cType, method, ...)
GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)
void *	GblInstance_private (const GblInstance *pSelf, GblType base)
GblInstance *	GblInstance_public (const void *pPriv, GblType base)
GblType	GblInstance_typeOf (const GblInstance *pSelf)
size_t	GblInstance_size (const GblInstance *pSelf)
size_t	GblInstance_privateSize (const GblInstance *pSelf)
size_t	GblInstance_totalSize (const GblInstance *pSelf)
GblClass *	GblInstance_class (const GblInstance *pSelf)
GBL_RESULT	GblInstance_swizzleClass (GblInstance *pSelf, GblClass *pClass)
GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)
GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

Object representing a thread, its local storage, and logic.

GblThread encapsulates an operating system thread, its local storage, and the logic that is run within it.

See also

GblThreadClass

Definition at line 99 of file gimbal_thread.h.

Friends And Related Symbol Documentation

GblThread_create [1/2]

#define GblThread_create (   ... )

related

Creates a GblThread instance with the given callback and userdata and optionally starts its execution immediately.

GblThread_ref()

GblThread * GblThread_ref ( const GblThread *  pSelf )

related

Returns a new reference to an existing thread, incrementing its reference count by 1.

GblThread_unref()

GblRefCount GblThread_unref ( GblThread *  pSelf )

related

Decrements the reference count of a GblThread instance, deleting it if it's the last one.

GblThread_isJoined()

GblBool GblThread_isJoined ( const GblThread *  pSelf )

related

Returns GBL_TRUE if the given thread has been joined with its parent and is done executing, GBL_FALSE otherwise.

GblThread_name()

const char * GblThread_name ( const GblThread *  pSelf )

related

Returns the string name assigned to the given thread.

GblThread_setName()

GBL_RESULT GblThread_setName ( GblThread *  pSelf, const char *  pName  )

related

Sets the string name pName to be the name of the given thread.

GblThread_closure()

GblClosure * GblThread_closure ( const GblThread *  pSelf )

related

Returns the closure assigned to the given thread, or NULL if there isn't one.

GblThread_setClosure()

void GblThread_setClosure ( GblThread *  pSelf, GblClosure *  pClosure  )

related

Assigns the closure of the given thread to pClosure, freeing the previous closure if there was one.

GblThread_callback()

GblThreadFn GblThread_callback ( const GblThread *  pSelf )

related

Returns the C callback function assigned to the given thread, or NULL if there isn't one.

GblThread_setCallback()

void GblThread_setCallback ( GblThread *  pSelf, GblThreadFn  pCb  )

related

Assigns the C callback function of the given thread to pCb, which will be executed with the thread.

GblThread_setPriority()

GBL_RESULT GblThread_setPriority ( GblThread *  pSelf, GBL_THREAD_PRIORITY  priority  )

related

Sets the priority of the given thread to priority.

GblThread_setAffinity()

GBL_RESULT GblThread_setAffinity ( GblThread *  pSelf, GblThreadAffinity  affinity  )

related

Sets the CPU affinity of the given thread to affinity.

GblThread_start()

GBL_RESULT GblThread_start ( GblThread *  pSelf )

related

Immediately starts a thread which has not yet joined or finished executing.

GblThread_join()

GBL_RESULT GblThread_join ( GblThread *  pSelf )

related

Blocks execution of the current thread, awaiting the completion of the given thread.

GblThread_spinWait()

GBL_RESULT GblThread_spinWait ( GblThread *  pSelf )

related

Performs a non-blocking wait on the given thread, spinning on a timeout.

GblThread_current()

GblThread * GblThread_current ( void  )

related

Returns a pointer to the GblThread instance associatedw with the current thread.

GblThread_yield()

GBL_RESULT GblThread_yield ( void  )

related

Suspends execution of the current thread, allowing other threads to execute temporarily.

GblThread_nanoSleep [1/2]

#define GblThread_nanoSleep (   ... )

related

Sleeps the current thread for nsec nanoseconds, returning the remaining time optionally within pRemainder.

GblThread_exit [1/2]

#define GblThread_exit (   ... )

related

Ends execution of the currently executing thread, returning result and storing the given source context.

GblThread_create [2/2]

#define GblThread_create (   ... )

related

Provides default argument handling for GblThread_create()

Definition at line 207 of file gimbal_thread.h.

GblThread_exit [2/2]

#define GblThread_exit (   ... )

related

Provides default argument handling for GblThread_exit()

Definition at line 209 of file gimbal_thread.h.

GblThread_nanoSleep [2/2]

#define GblThread_nanoSleep (   ... )

related

Provides default argument handling for GblThread_nanoSleep()

Definition at line 211 of file gimbal_thread.h.

GblThread_foreach

#define GblThread_foreach (   ... )

related

Provides default argument handling for GblThread_foreach()

Definition at line 213 of file gimbal_thread.h.

Field Documentation

pClass

GblThreadClass* GblThread::pClass

Pointer to class/vtable structure.

Definition at line 99 of file gimbal_thread.h.

base

GblObject GblThread::base

Inherited base instance structure.

Definition at line 99 of file gimbal_thread.h.

returnStatus

GblCallRecord GblThread::returnStatus

Return information from a completed thread.

Definition at line 100 of file gimbal_thread.h.

signalStatus

volatile sig_atomic_t GblThread::signalStatus

Pending signal state for a given thread.

Definition at line 101 of file gimbal_thread.h.

state

GBL_THREAD_STATE GblThread::state

Current state for a given thread MAKE ME ATOMIC.

Definition at line 102 of file gimbal_thread.h.

---

The documentation for this struct was generated from the following file:

• gimbal_thread.h