const SemProcessNull_FOREVER |
 |
Used as the timeout value to specify wait forever
#define SemProcessNull_FOREVER (UInt)~(0)
enum SemProcessNull_Mode |
 |
Types of semaphores
typedef enum SemProcessNull_Mode {
SemProcessNull_Mode_COUNTING,
// Counting semaphore
SemProcessNull_Mode_BINARY
// Binary Semaphore
} SemProcessNull_Mode;
enum SemProcessNull_PendStatus |
 |
Error codes returned by Semaphore_pend
typedef enum SemProcessNull_PendStatus {
SemProcessNull_PendStatus_ERROR,
SemProcessNull_PendStatus_TIMEOUT,
SemProcessNull_PendStatus_SUCCESS
} SemProcessNull_PendStatus;
Module-Wide Built-Ins |
 |
// Get this module's unique id
Bool SemProcessNull_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool SemProcessNull_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 SemProcessNull_Module_getMask();
// Returns the diagnostics mask for this module
Void SemProcessNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
 |
typedef struct SemProcessNull_Object SemProcessNull_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct SemProcessNull_Struct SemProcessNull_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
 |
typedef struct SemProcessNull_Params {
// Instance config-params structure
// Common per-instance configs
// Semaphore mode. Default is COUNTING
} SemProcessNull_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config SemProcessNull_mode // instance |
 |
Semaphore mode. Default is COUNTING
DETAILS
When mode is BINARY , the semaphore has only two states, available
and unavailable. When mode is COUNTING, the semaphore keeps track of
number of times a semaphore is posted.
Instance Creation |
 |
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
count
initial semaphore count
key
globally unique key
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
This function creates a new
SemProcess object which is
initialized to count.
All semaphores created with the same key reference the same
underlying synchronization object and work between processes. The
underlying synchronization object should be automatically deleted when
all references to it have been deleted, and the reference count should
be maintained consistently across process forks or similar operations.
An implementation for a platform on which this is technically impossible
(e.g. an operating system that does not support multiple processes) may
provide a 'toy' implementation with behavior matching that of
ISemProcessSupport.
Instance Deletion |
 |
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
SemProcessNull_pend() // instance |
 |
Wait for the semaphore to become available
ARGUMENTS
handle
handle of a previously-created SemProcessNull instance object
timeout
timeout in microseconds
eb
error block
DETAILS
RETURNS
refer to description above
SemProcessNull_post() // instance |
 |
Increment the semaphore count
ARGUMENTS
handle
handle of a previously-created SemProcessNull instance object
eb
error block
RETURNS
true for success, false for error in error block
Instance Convertors |
 |
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
// unconditionally move 2 levels up the inheritance hierarchy
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
 |
Int SemProcessNull_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object
const SemProcessNull.FOREVER |
 |
Used as the timeout value to specify wait forever
XDCscript usage |
meta-domain |
const SemProcessNull.FOREVER = ~(0);
C SYNOPSIS
enum SemProcessNull.Mode |
 |
Types of semaphores
XDCscript usage |
meta-domain |
values of type SemProcessNull.Mode
const SemProcessNull.Mode_COUNTING;
// Counting semaphore
const SemProcessNull.Mode_BINARY;
// Binary Semaphore
C SYNOPSIS
enum SemProcessNull.PendStatus |
 |
Error codes returned by Semaphore_pend
XDCscript usage |
meta-domain |
values of type SemProcessNull.PendStatus
const SemProcessNull.PendStatus_ERROR;
const SemProcessNull.PendStatus_TIMEOUT;
const SemProcessNull.PendStatus_SUCCESS;
C SYNOPSIS
metaonly config SemProcessNull.common$ // module-wide |
 |
Common module configuration parameters
XDCscript usage |
meta-domain |
DETAILS
All modules have this configuration parameter. Its name
contains the '$' character to ensure it does not conflict with
configuration parameters declared by the module. This allows
new configuration parameters to be added in the future without
any chance of breaking existing modules.
Instance Config Parameters |
 |
XDCscript usage |
meta-domain |
var params = new SemProcessNull.Params;
// Instance config-params object
// Semaphore mode. Default is COUNTING
config SemProcessNull.mode // instance |
 |
Semaphore mode. Default is COUNTING
XDCscript usage |
meta-domain |
var params = new SemProcessNull.Params;
...
DETAILS
When mode is BINARY , the semaphore has only two states, available
and unavailable. When mode is COUNTING, the semaphore keeps track of
number of times a semaphore is posted.
C SYNOPSIS
Instance Creation |
 |
XDCscript usage |
meta-domain |
var params =
new SemProcessNull.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = SemProcessNull.create(Int count, Int key, params);
// Create an instance-object
ARGUMENTS
count
initial semaphore count
key
globally unique key
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
This function creates a new
SemProcess object which is
initialized to count.
All semaphores created with the same key reference the same
underlying synchronization object and work between processes. The
underlying synchronization object should be automatically deleted when
all references to it have been deleted, and the reference count should
be maintained consistently across process forks or similar operations.
An implementation for a platform on which this is technically impossible
(e.g. an operating system that does not support multiple processes) may
provide a 'toy' implementation with behavior matching that of
ISemProcessSupport.