module xdc.runtime.knl.GateThreadSupportNull
index URL
XDCspec summary sourced in xdc/runtime/knl/GateThreadSupportNull.xdc
module GateThreadSupportNull {  ...
// inherits xdc.runtime.knl.IGateThreadSupport
    // inherits xdc.runtime.IGateProvider
        // inherits xdc.runtime.IModule
instance:  ...
C synopsis target-domain
#include <xdc/runtime/knl/GateThreadSupportNull.h>
module-wide constants & types
    #define GateThreadSupportNull_Q_BLOCKING// Blocking quality (Int)1
    #define GateThreadSupportNull_Q_PREEMPTING// Preempting quality (Int)2
module-wide functions
    Bool GateThreadSupportNull_query// Runtime test for a particular gate quality( Int qual );
module-wide built-ins
    Types_ModuleId GateThreadSupportNull_Module_id// Get this module's unique id( );
    Bool GateThreadSupportNull_Module_startupDone// Test if this module has completed startup( );
    IHeap_Handle GateThreadSupportNull_Module_heap// The heap from which this module allocates memory( );
    Bool GateThreadSupportNull_Module_hasMask// Test whether this module has a diagnostics mask( );
    Bits16 GateThreadSupportNull_Module_getMask// Returns the diagnostics mask for this module( );
    Void GateThreadSupportNull_Module_setMask// Set the diagnostics mask for this module( Bits16 mask );
per-instance object types
    typedef struct GateThreadSupportNull_Object// Opaque internal representation of an instance object GateThreadSupportNull_Object;
    typedef GateThreadSupportNull_Object *GateThreadSupportNull_Handle// Client reference to an instance object;
    typedef struct GateThreadSupportNull_Struct// Opaque client structure large enough to hold an instance object GateThreadSupportNull_Struct;
 
    GateThreadSupportNull_Handle GateThreadSupportNull_handle// Convert this instance structure pointer into an instance handle( GateThreadSupportNull_Struct *structP );
    GateThreadSupportNull_Struct *GateThreadSupportNull_struct// Convert this instance handle into an instance structure pointer( GateThreadSupportNull_Handle handle );
per-instance config parameters
    typedef struct GateThreadSupportNull_Params// Instance config-params structure {
        IInstance_Params *instance;
    } GateThreadSupportNull_Params;
 
    Void GateThreadSupportNull_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation( GateThreadSupportNull_Params *params );
per-instance creation
    GateThreadSupportNull_Handle GateThreadSupportNull_create// Allocate and initialize a new instance object and return its handle( const GateThreadSupportNull_Params *params, Error_Block *eb );
    Void GateThreadSupportNull_construct// Initialize a new instance object inside the provided structure( GateThreadSupportNull_Struct *structP, const GateThreadSupportNull_Params *params );
per-instance deletion
    Void GateThreadSupportNull_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL( GateThreadSupportNull_Handle *handleP );
    Void GateThreadSupportNull_destruct// Finalize the instance object inside the provided structure( GateThreadSupportNull_Struct *structP );
per-instance functions
    IArg GateThreadSupportNull_enter// Enter this gate( GateThreadSupportNull_Handle handle );
    Void GateThreadSupportNull_leave// Leave this gate( GateThreadSupportNull_Handle handle, IArg key );
per-instance convertors
    IGateThreadSupport_Handle GateThreadSupportNull_Handle_upCast// unconditionally move one level up the inheritance hierarchy( GateThreadSupportNull_Handle handle );
    GateThreadSupportNull_Handle GateThreadSupportNull_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure( IGateThreadSupport_Handle handle );
    IGateProvider_Handle GateThreadSupportNull_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy( GateThreadSupportNull_Handle handle );
    GateThreadSupportNull_Handle GateThreadSupportNull_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure( IGateProvider_Handle handle );
per-instance built-ins
    Int GateThreadSupportNull_Object_count// The number of statically-created instance objects( );
    GateThreadSupportNull_Handle GateThreadSupportNull_Object_get// The handle of the i-th statically-created instance object (array == NULL)( GateThreadSupportNull_Object *array, Int i );
    GateThreadSupportNull_Handle GateThreadSupportNull_Object_first// The handle of the first dynamically-created instance object, or NULL( );
    GateThreadSupportNull_Handle GateThreadSupportNull_Object_next// The handle of the next dynamically-created instance object, or NULL( GateThreadSupportNull_Handle handle );
    IHeap_Handle GateThreadSupportNull_Object_heap// The heap used to allocate dynamically-created instance objects( );
    Types_Label *GateThreadSupportNull_Handle_label// The label associated with this instance object( GateThreadSupportNull_Handle handle, Types_Label *buf );
    String GateThreadSupportNull_Handle_name// The name of this instance object( GateThreadSupportNull_Handle handle );
 
XDCscript usage meta-domain
var GateThreadSupportNull = xdc.useModule('xdc.runtime.knl.GateThreadSupportNull');
module-wide constants & types
    const GateThreadSupportNull.Q_BLOCKING// Blocking quality = 1;
    const GateThreadSupportNull.Q_PREEMPTING// Preempting quality = 2;
module-wide config parameters
    GateThreadSupportNull.common$// Common module configuration parameters = Types.Common$ undefined;
module-wide functions
    GateThreadSupportNull.queryMeta// Configuration time test for a particular gate quality( Int qual ) returns Bool
per-instance config parameters
    var params = new GateThreadSupportNull.Params// Instance config-params object;
per-instance creation
    var inst = GateThreadSupportNull.create// Create an instance-object( params );
 
XDCspec declarations sourced in xdc/runtime/knl/GateThreadSupportNull.xdc
package xdc.runtime.knl;
 
module GateThreadSupportNull inherits IGateThreadSupport {
module-wide constants & types
    const Int Q_BLOCKING// Blocking quality = 1;
    const Int Q_PREEMPTING// Preempting quality = 2;
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
module-wide functions
    Bool query// Runtime test for a particular gate quality( Int qual );
 
    metaonly Bool queryMeta// Configuration time test for a particular gate quality( Int qual );
 
 
instance:
per-instance creation
    create// Create an instance-object( );
per-instance functions
    IArg enter// Enter this gate( );
    Void leave// Leave this gate( IArg key );
}
 
const GateThreadSupportNull.Q_BLOCKING
index URL

Blocking quality

XDCscript usage meta-domain
const GateThreadSupportNull.Q_BLOCKING = 1;
C synopsis target-domain
#define GateThreadSupportNull_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 GateThreadSupportNull.Q_PREEMPTING
index URL

Preempting quality

XDCscript usage meta-domain
const GateThreadSupportNull.Q_PREEMPTING = 2;
C synopsis target-domain
#define GateThreadSupportNull_Q_PREEMPTING (Int)2
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
 
metaonly config GateThreadSupportNull.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
GateThreadSupportNull.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.
 
GateThreadSupportNull.query( )  // module-wide
index URL

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateThreadSupportNull_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.
 
metaonly GateThreadSupportNull.queryMeta( )  // module-wide
index URL

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateThreadSupportNull.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.
 
module-wide built-ins
index URL

C synopsis target-domain
Types_ModuleId GateThreadSupportNull_Module_id( );
// Get this module's unique id
 
Bool GateThreadSupportNull_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle GateThreadSupportNull_Module_heap( );
// The heap from which this module allocates memory
 
Bool GateThreadSupportNull_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 GateThreadSupportNull_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void GateThreadSupportNull_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
 
per-instance object types
index URL

C synopsis target-domain
typedef struct GateThreadSupportNull_Object GateThreadSupportNull_Object;
// Opaque internal representation of an instance object
 
typedef GateThreadSupportNull_Object *GateThreadSupportNull_Handle;
// Client reference to an instance object
 
typedef struct GateThreadSupportNull_Struct GateThreadSupportNull_Struct;
// Opaque client structure large enough to hold an instance object
 
GateThreadSupportNull_Handle GateThreadSupportNull_handle( GateThreadSupportNull_Struct *structP );
// Convert this instance structure pointer into an instance handle
 
GateThreadSupportNull_Struct *GateThreadSupportNull_struct( GateThreadSupportNull_Handle handle );
// Convert this instance handle into an instance structure pointer
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new GateThreadSupportNull.Params;
// Instance config-params object
C synopsis target-domain
typedef struct GateThreadSupportNull_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} GateThreadSupportNull_Params;
 
Void GateThreadSupportNull_Params_init( GateThreadSupportNull_Params *params );
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
per-instance creation
index URL

XDCscript usage meta-domain
var params = new GateThreadSupportNull.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateThreadSupportNull.create( params );
// Create an instance-object
C synopsis target-domain
GateThreadSupportNull_Handle GateThreadSupportNull_create( const GateThreadSupportNull_Params *params, Error_Block *eb );
// Allocate and initialize a new instance object and return its handle
 
Void GateThreadSupportNull_construct( GateThreadSupportNull_Struct *structP, const GateThreadSupportNull_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)
 
per-instance deletion
index URL

C synopsis target-domain
Void GateThreadSupportNull_delete( GateThreadSupportNull_Handle *handleP );
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateThreadSupportNull_destruct( GateThreadSupportNull_Struct *structP );
// Finalize the instance object inside the provided structure
 
GateThreadSupportNull.enter( )  // per-instance
index URL

Enter this gate

C synopsis target-domain
IArg GateThreadSupportNull_enter( GateThreadSupportNull_Handle handle );
 
ARGUMENTS
handle — handle of a previously-created GateThreadSupportNull 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.
 
GateThreadSupportNull.leave( )  // per-instance
index URL

Leave this gate

C synopsis target-domain
Void GateThreadSupportNull_leave( GateThreadSupportNull_Handle handle, IArg key );
 
ARGUMENTS
handle — handle of a previously-created GateThreadSupportNull 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).
 
per-instance convertors
index URL

C synopsis target-domain
IGateThreadSupport_Handle GateThreadSupportNull_Handle_upCast( GateThreadSupportNull_Handle handle );
// unconditionally move one level up the inheritance hierarchy
 
GateThreadSupportNull_Handle GateThreadSupportNull_Handle_downCast( IGateThreadSupport_Handle handle );
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateThreadSupportNull_Handle_upCast2( GateThreadSupportNull_Handle handle );
// unconditionally move 2 levels up the inheritance hierarchy
 
GateThreadSupportNull_Handle GateThreadSupportNull_Handle_downCast2( IGateProvider_Handle handle );
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
per-instance built-ins
index URL

C synopsis target-domain
Int GateThreadSupportNull_Object_count( );
// The number of statically-created instance objects
 
GateThreadSupportNull_Handle GateThreadSupportNull_Object_get( GateThreadSupportNull_Object *array, Int i );
// The handle of the i-th statically-created instance object (array == NULL)
 
GateThreadSupportNull_Handle GateThreadSupportNull_Object_first( );
// The handle of the first dynamically-created instance object, or NULL
 
GateThreadSupportNull_Handle GateThreadSupportNull_Object_next( GateThreadSupportNull_Handle handle );
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateThreadSupportNull_Object_heap( );
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateThreadSupportNull_Handle_label( GateThreadSupportNull_Handle handle, Types_Label *buf );
// The label associated with this instance object
 
String GateThreadSupportNull_Handle_name( GateThreadSupportNull_Handle handle );
// The name of this instance object
generated on Fri, 04 Sep 2009 23:26:27 GMT