module xdc.runtime.knl.Sync |
![](../../../Arrow_left.png) |
![](../../../Arrow_up.png) |
![](../../../Arrow_right.png) |
Provides synchronization APIs when an ISync.Handle is available
The application must first obtain an ISync.Handle.
It can get such a handle by directly calling
SyncGeneric.create or
SyncSemThread.create. Then the application can use the generic
APIs provided by this module.
#include <xdc/runtime/knl/Sync.h>
Functions |
Bool | |
Void | |
Int | |
Functions common to all target modules |
|
|
Typedefs |
typedef enum | |
enum Sync_WaitStatus |
![](../../../Arrow_up.png) |
Error codes returned by Sync_wait
typedef enum Sync_WaitStatus {
Sync_WaitStatus_ERROR,
Sync_WaitStatus_TIMEOUT,
Sync_WaitStatus_SUCCESS
} Sync_WaitStatus;
Sync_query() // module-wide |
![](../../../Arrow_up.png) |
Query for a particular quality
ARGUMENTS
sync
sync handle
qual
quality
RETURNS
TRUE or FALSE.
DETAILS
FALSE is returned if quality not supported.
Sync_signal() // module-wide |
![](../../../Arrow_up.png) |
Called at completion of an activity
ARGUMENTS
sync
sync handle
DETAILS
This function is non-blocking. It is also required that the underlying
sync be binary in nature.
Sync_wait() // module-wide |
![](../../../Arrow_up.png) |
Called to wait/poll for completion of an activity
ARGUMENTS
sync
sync handle
timeout
timeout in microseconds
RETURNS
see description above
DETAILS
This function can block. Non-blocking implementations should return
;
Wait for the semaphore to become available.
Module-Wide Built-Ins |
![](../../../Arrow_up.png) |
// Get this module's unique id
Bool Sync_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool Sync_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 Sync_Module_getMask();
// Returns the diagnostics mask for this module
Void Sync_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
var Sync = xdc.useModule('xdc.runtime.knl.Sync');
local proxy modules
module-wide constants & types
module-wide config parameters
generated on Fri, 28 May 2010 20:24:30 GMT