module ti.sdo.fc.utils.osal.noOS.GateMPNull
C synopsis target-domain sourced in ti/sdo/fc/utils/osal/noOS/GateMPNull.xdc
#include <ti/sdo/fc/utils/osal/noOS/GateMPNull.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all IGateProcessSupport modules
Int 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
#define
Typedefs
typedef struct
typedef struct
typedef struct
 
 
const GateMPNull_GETREFCOUNT_FAILED

Status returned by getReferenceCount when there is an error

C synopsis target-domain
#define GateMPNull_GETREFCOUNT_FAILED (Int)-1
 
 
const GateMPNull_Q_BLOCKING

Blocking quality

C synopsis target-domain
#define GateMPNull_Q_BLOCKING (Int)1
 
DETAILS
Gates with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate.
 
const GateMPNull_Q_PREEMPTING

Preempting quality

C synopsis target-domain
#define GateMPNull_Q_PREEMPTING (Int)2
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
 
GateMPNull_query()  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateMPNull_query(Int qual);
 
ARGUMENTS
qual — constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality, and FALSE otherwise, which includes the case when the gate does not recognize the constant describing the quality.
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId GateMPNull_Module_id();
// Get this module's unique id
 
Bool GateMPNull_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateMPNull_Module_heap();
// The heap from which this module allocates memory
 
Bool GateMPNull_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateMPNull_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateMPNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct GateMPNull_Object GateMPNull_Object;
// Opaque internal representation of an instance object
 
typedef GateMPNull_Object *GateMPNull_Handle;
// Client reference to an instance object
 
typedef struct GateMPNull_Struct GateMPNull_Struct;
// Opaque client structure large enough to hold an instance object
 
GateMPNull_Handle GateMPNull_handle(GateMPNull_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateMPNull_Struct *GateMPNull_struct(GateMPNull_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct GateMPNull_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    Int key;
    // globally unique key for SysV-style semaphore
} GateMPNull_Params;
 
Void GateMPNull_Params_init(GateMPNull_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config GateMPNull_key  // instance

globally unique key for SysV-style semaphore

C synopsis target-domain
      ...
    Int key;
 
Instance Creation

C synopsis target-domain
GateMPNull_Handle GateMPNull_create(const GateMPNull_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateMPNull_construct(GateMPNull_Struct *structP, const GateMPNull_Params *params);
// 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)
DETAILS
This function creates a new GateProcess object which is initialized to count. All gates 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 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' implemenation with behavior matching that of IGateProcessSupport.
Instance Deletion

C synopsis target-domain
Void GateMPNull_delete(GateMPNull_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateMPNull_destruct(GateMPNull_Struct *structP);
// Finalize the instance object inside the provided structure
 
GateMPNull_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateMPNull_enter(GateMPNull_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created GateMPNull instance object
DETAILS
Each gate provider can implement mutual exclusion using different algorithms; e.g., disabling all scheduling, disabling the scheduling of all threads below a specified "priority level", suspending the caller when the gate has been entered by another thread and re-enabling it when the the other thread leaves the gate. However, in all cases, after this method returns that caller has exclusive access to the data protected by this gate.
A thread may reenter a gate without blocking or failing.
RETURNS
Returns a "key" that is used to leave this gate; this value is used to restore thread preemption to the state that existed just prior to entering this gate.
 
GateMPNull_getReferenceCount()  // instance

Get the number of processes with references to this Gate

C synopsis target-domain
Int GateMPNull_getReferenceCount(GateMPNull_Handle handle, Error_Block *err);
 
ARGUMENTS
handle — handle of a previously-created GateMPNull instance object
err — Pointer to Error.Block
RETURNS
Returns the number of processes that possess a reference to this gate, or GETREFCOUNT_FAILED if an error occured. A 'toy' implementation should always return 0.
 
GateMPNull_leave()  // instance

Leave this gate

C synopsis target-domain
Void GateMPNull_leave(GateMPNull_Handle handle, IArg key);
 
ARGUMENTS
handle — handle of a previously-created GateMPNull instance object
key — the value returned by a matching call to enter
DETAILS
This method is only called by threads that have previously entered this gate via enter. After this method returns, the caller must not access the data structure protected by this gate (unless the caller has entered the gate more than once and other calls to leave remain to balance the number of previous calls to enter).
Instance Convertors

C synopsis target-domain
IGateProcessSupport_Handle GateMPNull_Handle_upCast(GateMPNull_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateMPNull_Handle GateMPNull_Handle_downCast(IGateProcessSupport_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateThreadSupport_Handle GateMPNull_Handle_upCast2(GateMPNull_Handle handle);
// unconditionally move 2 levels up the inheritance hierarchy
 
GateMPNull_Handle GateMPNull_Handle_downCast2(IGateThreadSupport_Handle handle);
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateMPNull_Handle_upCast3(GateMPNull_Handle handle);
// unconditionally move 3 levels up the inheritance hierarchy
 
GateMPNull_Handle GateMPNull_Handle_downCast3(IGateProvider_Handle handle);
// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateMPNull_Object_count();
// The number of statically-created instance objects
 
GateMPNull_Handle GateMPNull_Object_get(GateMPNull_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateMPNull_Handle GateMPNull_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateMPNull_Handle GateMPNull_Object_next(GateMPNull_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateMPNull_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateMPNull_Handle_label(GateMPNull_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateMPNull_Handle_name(GateMPNull_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/fc/utils/osal/noOS/GateMPNull.xdc
var GateMPNull = xdc.useModule('ti.sdo.fc.utils.osal.noOS.GateMPNull');
module-wide constants & types
module-wide config parameters
module-wide functions
per-instance config parameters
    var params = new GateMPNull.Params// Instance config-params object;
        params.key// globally unique key for SysV-style semaphore = Int -1;
per-instance creation
    var inst = GateMPNull.create// Create an instance-object(params);
 
 
const GateMPNull.GETREFCOUNT_FAILED

Status returned by getReferenceCount when there is an error

XDCscript usage meta-domain
const GateMPNull.GETREFCOUNT_FAILED = -1;
 
C SYNOPSIS
 
const GateMPNull.Q_BLOCKING

Blocking quality

XDCscript usage meta-domain
const GateMPNull.Q_BLOCKING = 1;
 
DETAILS
Gates with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate.
C SYNOPSIS
 
const GateMPNull.Q_PREEMPTING

Preempting quality

XDCscript usage meta-domain
const GateMPNull.Q_PREEMPTING = 2;
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
 
metaonly config GateMPNull.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
GateMPNull.common$ = Types.Common$ undefined;
 
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.
 
metaonly GateMPNull.queryMeta()  // module-wide

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateMPNull.queryMeta(Int qual) returns Bool
 
ARGUMENTS
qual — constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality, and FALSE otherwise, which includes the case when the gate does not recognize the constant describing the quality.
Instance Config Parameters

XDCscript usage meta-domain
var params = new GateMPNull.Params;
// Instance config-params object
    params.key = Int -1;
    // globally unique key for SysV-style semaphore
 
config GateMPNull.key  // instance

globally unique key for SysV-style semaphore

XDCscript usage meta-domain
var params = new GateMPNull.Params;
  ...
params.key = Int -1;
 
C SYNOPSIS
Instance Creation

XDCscript usage meta-domain
var params = new GateMPNull.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateMPNull.create(params);
// Create an instance-object
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)
DETAILS
This function creates a new GateProcess object which is initialized to count. All gates 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 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' implemenation with behavior matching that of IGateProcessSupport.
generated on Thu, 15 Dec 2011 10:52:03 GMT