module xdc.runtime.knl.GateProcessSupportNull
index URL
XDCspec summary sourced in xdc/runtime/knl/GateProcessSupportNull.xdc
module GateProcessSupportNull {  ...
// inherits xdc.runtime.knl.IGateProcessSupport
    // inherits xdc.runtime.knl.IGateThreadSupport
        // inherits xdc.runtime.IGateProvider
            // inherits xdc.runtime.IModule
instance:  ...
C synopsis target-domain
#include <xdc/runtime/knl/GateProcessSupportNull.h>
module-wide constants & types
    #define GateProcessSupportNull_GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error (Int)-1
    #define GateProcessSupportNull_Q_BLOCKING// Blocking quality (Int)1
    #define GateProcessSupportNull_Q_PREEMPTING// Preempting quality (Int)2
module-wide functions
    Bool GateProcessSupportNull_query// Runtime test for a particular gate quality( Int qual );
module-wide built-ins
    Types_ModuleId GateProcessSupportNull_Module_id// Get this module's unique id( );
    Bool GateProcessSupportNull_Module_startupDone// Test if this module has completed startup( );
    IHeap_Handle GateProcessSupportNull_Module_heap// The heap from which this module allocates memory( );
per-instance object types
    typedef struct GateProcessSupportNull_Object// Opaque internal representation of an instance object GateProcessSupportNull_Object;
    typedef GateProcessSupportNull_Object *GateProcessSupportNull_Handle// Client reference to an instance object;
    typedef struct GateProcessSupportNull_Struct// Opaque client structure large enough to hold an instance object GateProcessSupportNull_Struct;
 
    GateProcessSupportNull_Handle GateProcessSupportNull_handle// Convert this instance structure pointer into an instance handle( GateProcessSupportNull_Struct *structP );
    GateProcessSupportNull_Struct *GateProcessSupportNull_struct// Convert this instance handle into an instance structure pointer( GateProcessSupportNull_Handle handle );
per-instance config parameters
    typedef struct GateProcessSupportNull_Params// Instance config-params structure {
        IInstance_Params *instance;
        Int key// globally unique key for SysV-style semaphore;
    } GateProcessSupportNull_Params;
 
    Void GateProcessSupportNull_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation( GateProcessSupportNull_Params *params );
per-instance creation
    GateProcessSupportNull_Handle GateProcessSupportNull_create// Allocate and initialize a new instance object and return its handle( const GateProcessSupportNull_Params *params, Error_Block *eb );
    Void GateProcessSupportNull_construct// Initialize a new instance object inside the provided structure( GateProcessSupportNull_Struct *structP, const GateProcessSupportNull_Params *params );
per-instance deletion
    Void GateProcessSupportNull_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL( GateProcessSupportNull_Handle *handleP );
    Void GateProcessSupportNull_destruct// Finalize the instance object inside the provided structure( GateProcessSupportNull_Struct *structP );
per-instance functions
    IArg GateProcessSupportNull_enter// Enter this gate( GateProcessSupportNull_Handle handle );
    Int GateProcessSupportNull_getReferenceCount// Get the number of processes with references to this Gate( GateProcessSupportNull_Handle handle, Error_Block *err );
    Void GateProcessSupportNull_leave// Leave this gate( GateProcessSupportNull_Handle handle, IArg key );
per-instance convertors
    IGateProcessSupport_Handle GateProcessSupportNull_Handle_upCast// unconditionally move one level up the inheritance hierarchy( GateProcessSupportNull_Handle handle );
    GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure( IGateProcessSupport_Handle handle );
    IGateThreadSupport_Handle GateProcessSupportNull_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy( GateProcessSupportNull_Handle handle );
    GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure( IGateThreadSupport_Handle handle );
    IGateProvider_Handle GateProcessSupportNull_Handle_upCast3// unconditionally move 3 levels up the inheritance hierarchy( GateProcessSupportNull_Handle handle );
    GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast3// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure( IGateProvider_Handle handle );
per-instance built-ins
    Int GateProcessSupportNull_Object_count// The number of statically-created instance objects( );
    GateProcessSupportNull_Handle GateProcessSupportNull_Object_get// The handle of the i-th statically-created instance object (array == NULL)( GateProcessSupportNull_Object *array, Int i );
    GateProcessSupportNull_Handle GateProcessSupportNull_Object_first// The handle of the first dynamically-created instance object, or NULL( );
    GateProcessSupportNull_Handle GateProcessSupportNull_Object_next// The handle of the next dynamically-created instance object, or NULL( GateProcessSupportNull_Handle handle );
    IHeap_Handle GateProcessSupportNull_Object_heap// The heap used to allocate dynamically-created instance objects( );
    Types_Label *GateProcessSupportNull_Handle_label// The label associated with this instance object( GateProcessSupportNull_Handle handle, Types_Label *buf );
    String GateProcessSupportNull_Handle_name// The name of this instance object( GateProcessSupportNull_Handle handle );
 
XDCscript usage meta-domain
var GateProcessSupportNull = xdc.useModule('xdc.runtime.knl.GateProcessSupportNull');
module-wide constants & types
    const GateProcessSupportNull.GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error = -1;
    const GateProcessSupportNull.Q_BLOCKING// Blocking quality = 1;
    const GateProcessSupportNull.Q_PREEMPTING// Preempting quality = 2;
module-wide config parameters
    GateProcessSupportNull.common$// Common module configuration parameters = Types.Common$ undefined;
module-wide functions
    GateProcessSupportNull.queryMeta// Configuration time test for a particular gate quality( Int qual ) returns Bool
per-instance config parameters
    var params = new GateProcessSupportNull.Params// Instance config-params object;
        params.key// globally unique key for SysV-style semaphore = Int -1;
per-instance creation
    var inst = GateProcessSupportNull.create// Create an instance-object( params );
 
XDCspec declarations sourced in xdc/runtime/knl/GateProcessSupportNull.xdc
package xdc.runtime.knl;
 
module GateProcessSupportNull inherits IGateProcessSupport {
module-wide constants & types
    const Int GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error = -1;
    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 config parameters
    config Int key// globally unique key for SysV-style semaphore = -1;
per-instance creation
    create// Create an instance-object( );
per-instance functions
    IArg enter// Enter this gate( );
    Int getReferenceCount// Get the number of processes with references to this Gate( Error.Block *err );
    Void leave// Leave this gate( IArg key );
}
 
const GateProcessSupportNull.GETREFCOUNT_FAILED
index URL

Status returned by getReferenceCount when there is an error

XDCscript usage meta-domain
const GateProcessSupportNull.GETREFCOUNT_FAILED = -1;
C synopsis target-domain
#define GateProcessSupportNull_GETREFCOUNT_FAILED (Int)-1
 
 
const GateProcessSupportNull.Q_BLOCKING
index URL

Blocking quality

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

Preempting quality

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

Common module configuration parameters

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

Runtime test for a particular gate quality

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

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateProcessSupportNull.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 GateProcessSupportNull_Module_id( );
// Get this module's unique id
 
Bool GateProcessSupportNull_Module_startupDone( );
// Test if this module has completed startup
IHeap_Handle GateProcessSupportNull_Module_heap( );
// The heap from which this module allocates memory
 
 
per-instance object types
index URL

C synopsis target-domain
typedef struct GateProcessSupportNull_Object GateProcessSupportNull_Object;
// Opaque internal representation of an instance object
 
typedef GateProcessSupportNull_Object *GateProcessSupportNull_Handle;
// Client reference to an instance object
 
typedef struct GateProcessSupportNull_Struct GateProcessSupportNull_Struct;
// Opaque client structure large enough to hold an instance object
 
GateProcessSupportNull_Handle GateProcessSupportNull_handle( GateProcessSupportNull_Struct *structP );
// Convert this instance structure pointer into an instance handle
 
GateProcessSupportNull_Struct *GateProcessSupportNull_struct( GateProcessSupportNull_Handle handle );
// Convert this instance handle into an instance structure pointer
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new GateProcessSupportNull.Params;
// Instance config-params object
    params.key = Int -1;
    // globally unique key for SysV-style semaphore
C synopsis target-domain
typedef struct GateProcessSupportNull_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    Int key;
    // globally unique key for SysV-style semaphore
} GateProcessSupportNull_Params;
 
Void GateProcessSupportNull_Params_init( GateProcessSupportNull_Params *params );
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config GateProcessSupportNull.key  // per-instance
index URL

globally unique key for SysV-style semaphore

XDCscript usage meta-domain
var params = new GateProcessSupportNull.Params;
  ...
params.key = Int -1;
C synopsis target-domain
struct GateProcessSupportNull_Params {
      ...
    Int key;
 
 
per-instance creation
index URL

XDCscript usage meta-domain
var params = new GateProcessSupportNull.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateProcessSupportNull.create( params );
// Create an instance-object
C synopsis target-domain
GateProcessSupportNull_Handle GateProcessSupportNull_create( const GateProcessSupportNull_Params *params, Error_Block *eb );
// Allocate and initialize a new instance object and return its handle
 
Void GateProcessSupportNull_construct( GateProcessSupportNull_Struct *structP, const GateProcessSupportNull_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.
 
per-instance deletion
index URL

C synopsis target-domain
Void GateProcessSupportNull_delete( GateProcessSupportNull_Handle *handleP );
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateProcessSupportNull_destruct( GateProcessSupportNull_Struct *structP );
// Finalize the instance object inside the provided structure
 
GateProcessSupportNull.enter( )  // per-instance
index URL

Enter this gate

C synopsis target-domain
IArg GateProcessSupportNull_enter( GateProcessSupportNull_Handle handle );
 
ARGUMENTS
handle — handle of a previously-created GateProcessSupportNull 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.
 
GateProcessSupportNull.getReferenceCount( )  // per-instance
index URL

Get the number of processes with references to this Gate

C synopsis target-domain
Int GateProcessSupportNull_getReferenceCount( GateProcessSupportNull_Handle handle, Error_Block *err );
 
ARGUMENTS
handle — handle of a previously-created GateProcessSupportNull 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.
 
GateProcessSupportNull.leave( )  // per-instance
index URL

Leave this gate

C synopsis target-domain
Void GateProcessSupportNull_leave( GateProcessSupportNull_Handle handle, IArg key );
 
ARGUMENTS
handle — handle of a previously-created GateProcessSupportNull 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
IGateProcessSupport_Handle GateProcessSupportNull_Handle_upCast( GateProcessSupportNull_Handle handle );
// unconditionally move one level up the inheritance hierarchy
 
GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast( IGateProcessSupport_Handle handle );
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateThreadSupport_Handle GateProcessSupportNull_Handle_upCast2( GateProcessSupportNull_Handle handle );
// unconditionally move 2 levels up the inheritance hierarchy
 
GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast2( IGateThreadSupport_Handle handle );
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateProcessSupportNull_Handle_upCast3( GateProcessSupportNull_Handle handle );
// unconditionally move 3 levels up the inheritance hierarchy
 
GateProcessSupportNull_Handle GateProcessSupportNull_Handle_downCast3( IGateProvider_Handle handle );
// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure
 
per-instance built-ins
index URL

C synopsis target-domain
Int GateProcessSupportNull_Object_count( );
// The number of statically-created instance objects
 
GateProcessSupportNull_Handle GateProcessSupportNull_Object_get( GateProcessSupportNull_Object *array, Int i );
// The handle of the i-th statically-created instance object (array == NULL)
 
GateProcessSupportNull_Handle GateProcessSupportNull_Object_first( );
// The handle of the first dynamically-created instance object, or NULL
 
GateProcessSupportNull_Handle GateProcessSupportNull_Object_next( GateProcessSupportNull_Handle handle );
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateProcessSupportNull_Object_heap( );
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateProcessSupportNull_Handle_label( GateProcessSupportNull_Handle handle, Types_Label *buf );
// The label associated with this instance object
 
String GateProcessSupportNull_Handle_name( GateProcessSupportNull_Handle handle );
// The name of this instance object
generated on Thu, 25 Jun 2009 21:46:10 GMT