module ti.sdo.xdcruntime.linux.GateThreadSupport
C synopsis target-domain sourced in ti/sdo/xdcruntime/linux/GateThreadSupport.xdc
#include <ti/sdo/xdcruntime/linux/GateThreadSupport.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef struct
typedef struct
typedef struct
Constants
extern const Assert_Id 
extern const Error_Id 
 
const GateThreadSupport_Q_BLOCKING

Blocking quality

C synopsis target-domain
#define GateThreadSupport_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 GateThreadSupport_Q_PREEMPTING

Preempting quality

C synopsis target-domain
#define GateThreadSupport_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
config GateThreadSupport_A_POSIX_Error  // module-wide
C synopsis target-domain
extern const Assert_Id GateThreadSupport_A_POSIX_Error;
config GateThreadSupport_E_POSIX_Error  // module-wide
C synopsis target-domain
extern const Error_Id GateThreadSupport_E_POSIX_Error;
GateThreadSupport_query()  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateThreadSupport_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 GateThreadSupport_Module_id();
// Get this module's unique id
 
Bool GateThreadSupport_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateThreadSupport_Module_heap();
// The heap from which this module allocates memory
 
Bool GateThreadSupport_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateThreadSupport_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateThreadSupport_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct GateThreadSupport_Object GateThreadSupport_Object;
// Opaque internal representation of an instance object
 
typedef GateThreadSupport_Object *GateThreadSupport_Handle;
// Client reference to an instance object
 
typedef struct GateThreadSupport_Struct GateThreadSupport_Struct;
// Opaque client structure large enough to hold an instance object
 
GateThreadSupport_Handle GateThreadSupport_handle(GateThreadSupport_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateThreadSupport_Struct *GateThreadSupport_struct(GateThreadSupport_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct GateThreadSupport_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} GateThreadSupport_Params;
 
Void GateThreadSupport_Params_init(GateThreadSupport_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
Instance Creation

C synopsis target-domain
GateThreadSupport_Handle GateThreadSupport_create(const GateThreadSupport_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateThreadSupport_construct(GateThreadSupport_Struct *structP, const GateThreadSupport_Params *params, Error_Block *eb);
// 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)
Instance Deletion

C synopsis target-domain
Void GateThreadSupport_delete(GateThreadSupport_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateThreadSupport_destruct(GateThreadSupport_Struct *structP);
// Finalize the instance object inside the provided structure
GateThreadSupport_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateThreadSupport_enter(GateThreadSupport_Handle handle);
ARGUMENTS
handle — handle of a previously-created GateThreadSupport 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.
GateThreadSupport_leave()  // instance

Leave this gate

C synopsis target-domain
Void GateThreadSupport_leave(GateThreadSupport_Handle handle, IArg key);
ARGUMENTS
handle — handle of a previously-created GateThreadSupport 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
IGateThreadSupport_Handle GateThreadSupport_Handle_upCast(GateThreadSupport_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateThreadSupport_Handle GateThreadSupport_Handle_downCast(IGateThreadSupport_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateThreadSupport_Handle_upCast2(GateThreadSupport_Handle handle);
// unconditionally move 2 levels up the inheritance hierarchy
 
GateThreadSupport_Handle GateThreadSupport_Handle_downCast2(IGateProvider_Handle handle);
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateThreadSupport_Object_count();
// The number of statically-created instance objects
 
GateThreadSupport_Handle GateThreadSupport_Object_get(GateThreadSupport_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateThreadSupport_Handle GateThreadSupport_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateThreadSupport_Handle GateThreadSupport_Object_next(GateThreadSupport_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateThreadSupport_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateThreadSupport_Handle_label(GateThreadSupport_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateThreadSupport_Handle_name(GateThreadSupport_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/xdcruntime/linux/GateThreadSupport.xdc
var GateThreadSupport = xdc.useModule('ti.sdo.xdcruntime.linux.GateThreadSupport');
module-wide constants & types
module-wide config parameters
        msg: "A_POSIX_Error: a POSIX function returned failure"
    };
        msg: "E_POSIX_Error: a POSIX function returned failure, errno is %d"
    };
module-wide functions
per-instance config parameters
    var params = new GateThreadSupport.Params// Instance config-params object;
per-instance creation
    var inst = GateThreadSupport.create// Create an instance-object(params);
 
const GateThreadSupport.Q_BLOCKING

Blocking quality

XDCscript usage meta-domain
const GateThreadSupport.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 GateThreadSupport.Q_PREEMPTING

Preempting quality

XDCscript usage meta-domain
const GateThreadSupport.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
config GateThreadSupport.A_POSIX_Error  // module-wide
XDCscript usage meta-domain
GateThreadSupport.A_POSIX_Error = Assert.Desc {
    msg: "A_POSIX_Error: a POSIX function returned failure"
};
C SYNOPSIS
config GateThreadSupport.E_POSIX_Error  // module-wide
XDCscript usage meta-domain
GateThreadSupport.E_POSIX_Error = Error.Desc {
    msg: "E_POSIX_Error: a POSIX function returned failure, errno is %d"
};
C SYNOPSIS
metaonly config GateThreadSupport.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
GateThreadSupport.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 GateThreadSupport.queryMeta()  // module-wide

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateThreadSupport.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 GateThreadSupport.Params;
// Instance config-params object
Instance Creation

XDCscript usage meta-domain
var params = new GateThreadSupport.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateThreadSupport.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)
generated on Fri, 29 Oct 2010 00:26:49 GMT