module xdc.runtime.knl.SemThread

SemThread Manager

C synopsis
Individual elements
XDCscript usage
Individual elements

This module manages semaphores through its proxy ISemThreadSupport interface. It has a module wide config parameter Proxy which needs to be bound to an OS specific delegate before this module can be used. [ more ... ]

C synopsis target-domain sourced in xdc/runtime/knl/SemThread.xdc

#include <xdc/runtime/knl/SemThread.h>

Functions
Void	SemThread_construct// Initialize a new instance object inside the provided structure(SemThread_Struct structP, Int count, const SemThread_Params params, Error_Block *eb);
SemThread_Handle	SemThread_create// Allocate and initialize a new instance object and return its handle(Int count, const SemThread_Params params, Error_Block eb);
Void	SemThread_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(SemThread_Handle *handleP);
Void	SemThread_destruct// Finalize the instance object inside the provided structure(SemThread_Struct *structP);
Void	SemThread_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(SemThread_Params *params);
Functions common to all ISemaphore modules
Int	SemThread_pend// Wait for the semaphore to become available(SemThread_Handle handle, UInt timeout, Error_Block *eb);
Bool	SemThread_post// Increment the semaphore count(SemThread_Handle handle, Error_Block *eb);
Functions common to all target instances
	SemThread_handle// Convert this instance structure pointer into an instance handle, SemThread_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, SemThread_Handle_label// The label associated with this instance object, SemThread_Handle_name// The name of this instance object, SemThread_Handle_upCast// unconditionally move one level up the inheritance hierarchy, SemThread_Object_count// The number of statically-created instance objects, SemThread_Object_first// The handle of the first dynamically-created instance object, or NULL, SemThread_Object_get// The handle of the i-th statically-created instance object (array == NULL), SemThread_Object_heap// The heap used to allocate dynamically-created instance objects, SemThread_Object_next// The handle of the next dynamically-created instance object, or NULL, SemThread_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	SemThread_Module_getMask// Returns the diagnostics mask for this module, SemThread_Module_hasMask// Test whether this module has a diagnostics mask, SemThread_Module_heap// The heap from which this module allocates memory, SemThread_Module_id// Get this module's unique id, SemThread_Module_setMask// Set the diagnostics mask for this module, SemThread_Module_startupDone// Test if this module has completed startup
Defines
#define	SemThread_FOREVER// Used as the timeout value to specify wait forever (UInt)~(0)
Typedefs
typedef SemThread_Object *	SemThread_Handle// Client reference to an instance object;
typedef enum	SemThread_Mode// Types of semaphores ...
typedef struct	SemThread_Object// Opaque internal representation of an instance object SemThread_Object;
typedef struct	SemThread_Params// Instance config-params structure ...
typedef enum	SemThread_PendStatus// Error codes returned by Semaphore_pend ...
typedef struct	SemThread_Struct// Opaque client structure large enough to hold an instance object SemThread_Struct;

DETAILS

Here is an example showing how the proxy is bound to an BIOS 6.x specific delegate.

  var SemThread = xdc.useModule('xdc.runtime.knl.SemThread');
  SemThread.Proxy = xdc.useModule('ti.sysbios.xdcruntime.SemThreadSupport');

Typically the package containing the delegates have a Settings module that will bind all xdc.runtime.knl proxies. The following example sets up all the xdc.runtime.knl proxies.

  xdc.useModule("ti.sysbios.xdcruntime.Settings");

const SemThread_FOREVER