Empty ISync implementation used mainly for testing. [EXPERIMENTAL]
const SyncNull.NO_WAIT |
|
Used to specify no waiting
XDCscript usage |
meta-domain |
const SyncNull.NO_WAIT = 0;
#define SyncNull_NO_WAIT (UInt)0
const SyncNull.Q_BLOCKING |
|
Blocking quality
XDCscript usage |
meta-domain |
const SyncNull.Q_BLOCKING = 1;
#define SyncNull_Q_BLOCKING (Int)1
DETAILS
Implementations with this "quality" may cause the calling thread to
block;
const SyncNull.WAIT_FOREVER |
|
Used to wait forever
XDCscript usage |
meta-domain |
const SyncNull.WAIT_FOREVER = ~(0);
#define SyncNull_WAIT_FOREVER (UInt)~(0)
enum SyncNull.WaitStatus |
|
Error codes returned by Semaphore_pend
XDCscript usage |
meta-domain |
values of type SyncNull.WaitStatus
const SyncNull.WaitStatus_ERROR;
const SyncNull.WaitStatus_TIMEOUT;
const SyncNull.WaitStatus_SUCCESS;
typedef enum SyncNull_WaitStatus {
SyncNull_WaitStatus_ERROR,
SyncNull_WaitStatus_TIMEOUT,
SyncNull_WaitStatus_SUCCESS
} SyncNull_WaitStatus;
metaonly config SyncNull.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.
module-wide built-ins |
|
// Get this module's unique id
Bool SyncNull_Module_startupDone( );
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool SyncNull_Module_hasMask( );
// Test whether this module has a diagnostics mask
Bits16 SyncNull_Module_getMask( );
// Returns the diagnostics mask for this module
Void SyncNull_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
per-instance object types |
|
typedef struct SyncNull_Object SyncNull_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct SyncNull_Struct SyncNull_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
per-instance config parameters |
|
XDCscript usage |
meta-domain |
var params = new SyncNull.Params;
// Instance config-params object
typedef struct SyncNull_Params {
// Instance config-params structure
// Common per-instance configs
} SyncNull_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
per-instance creation |
|
XDCscript usage |
meta-domain |
var params =
new SyncNull.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = SyncNull.create( params );
// Create an instance-object
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
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)
per-instance deletion |
|
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
SyncNull.query( ) // per-instance |
|
Query for a particular quality
ARGUMENTS
handle
handle of a previously-created SyncNull instance object
qual
quality
RETURNS
TRUE or FALSE.
DETAILS
FALSE is returned if quality not supported.
SyncNull.signal( ) // per-instance |
|
Called at completion of an activity
ARGUMENTS
handle
handle of a previously-created SyncNull instance object
DETAILS
This function is non-blocking. It is also required that the underlying
sync be binary in nature.
This function does not take an Error.Block intentionally because
it can be called from ISR context.
SyncNull.wait( ) // per-instance |
|
Called to wait/poll for completion of an activity
ARGUMENTS
handle
handle of a previously-created SyncNull instance object
timeout
Timeout
eb
Hist Pointer to Error.Block
RETURNS
Refer to description above
DETAILS
This function can block. Non-blocking implementations should return
false to indicate a timeout.
per-instance convertors |
|
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
per-instance built-ins |
|
Int SyncNull_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