interface xdc.runtime.knl.ISemThreadSupport
index URL

Interface for OS specific back-end. [EXPERIMENTAL]

The xdc.runtime.knl package contains modules that provide typical OS services. These xdc.runtime.knl modules require proxies to be bound to an OS specific delegate. This specifies the interface to be implemented by the OS specific delegate for xdc.runtime.knl.SemThread module. [ more ... ]
XDCspec summary sourced in xdc/runtime/knl/ISemThreadSupport.xdc
interface ISemThreadSupport {  ...
// inherits xdc.runtime.knl.ISemaphore
    // inherits xdc.runtime.IModule
instance:  ...
XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
package xdc.runtime.knl;
 
interface ISemThreadSupport inherits ISemaphore {
module-wide constants & types
    const UInt FOREVER// Used as the timeout value to specify wait forever = ~(0);
 
    enum Mode// Types of semaphores {
        Mode_COUNTING// Counting semaphore,
        Mode_BINARY// Binary Semaphore
    };
 
    enum PendStatus// Error codes returned by Semaphore_pend {
        PendStatus_ERROR,
        PendStatus_TIMEOUT,
        PendStatus_SUCCESS
    };
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
 
 
instance:
per-instance config parameters
    config ISemaphore.Mode mode// Semaphore mode. Default is COUNTING = ISemaphore.Mode_COUNTING;
per-instance creation
    create// Create an instance-object( Int count );
per-instance functions
    Int pend// Wait for the semaphore to become available( UInt timeout, Error.Block *eb );
    Bool post// Increment the semaphore count( Error.Block *eb );
}
C synopsis target-domain
#include <xdc/runtime/knl/ISemThreadSupport.h>
per-instance object types
    typedef struct ISemThreadSupport_Object// Client reference to an abstract instance object *ISemThreadSupport_Handle;
per-instance config parameters
    typedef struct ISemThreadSupport_Params// Instance config-params structure {
        IInstance_Params *instance;
        ISemaphore_Mode mode// Semaphore mode. Default is COUNTING;
    } ISemThreadSupport_Params;
per-instance convertors
    ISemaphore_Handle ISemThreadSupport_Handle_upCast// unconditionally move one level up the inheritance hierarchy( ISemThreadSupport_Handle handle );
    ISemThreadSupport_Handle ISemThreadSupport_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure( ISemaphore_Handle handle );
 
DETAILS
The xdc.runtime.knl package contains modules that provide typical OS services. These xdc.runtime.knl modules require proxies to be bound to an OS specific delegate. This specifies the interface to be implemented by the OS specific delegate for xdc.runtime.knl.SemThread module.
This interface adds the create() function.
 
const ISemThreadSupport.FOREVER
index URL

Used as the timeout value to specify wait forever

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
const UInt FOREVER = ~(0);
 
 
enum ISemThreadSupport.Mode
index URL

Types of semaphores

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
enum Mode {
    Mode_COUNTING,
    // Counting semaphore
    Mode_BINARY
    // Binary Semaphore
};
 
 
enum ISemThreadSupport.PendStatus
index URL

Error codes returned by Semaphore_pend

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
enum PendStatus {
    PendStatus_ERROR,
    PendStatus_TIMEOUT,
    PendStatus_SUCCESS
};
 
 
metaonly config ISemThreadSupport.common$  // module-wide
index URL

Common module configuration parameters

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
metaonly config Types.Common$ common$;
 
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.
 
per-instance object types
index URL

C synopsis target-domain
typedef struct ISemThreadSupport_Object *ISemThreadSupport_Handle;
// Client reference to an abstract instance object
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new ISemThreadSupport.Params;
// Instance config-params object
    params.mode = ISemaphore.Mode ISemaphore.Mode_COUNTING;
    // Semaphore mode. Default is COUNTING
C synopsis target-domain
typedef struct ISemThreadSupport_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    ISemaphore_Mode mode;
    // Semaphore mode. Default is COUNTING
} ISemThreadSupport_Params;
 
config ISemThreadSupport.mode  // per-instance
index URL

Semaphore mode. Default is COUNTING

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
config ISemaphore.Mode mode = ISemaphore.Mode_COUNTING;
 
DETAILS
When mode is BINARY , the semaphore has only two states, available and unavailable. When mode is COUNTING, the semaphore keeps track of number of times a semaphore is posted.
 
per-instance creation
index URL

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
create( Int count );
// Create an instance-object
ARGUMENTS
count — initial semaphore count
DETAILS
This function creates a new Semaphore object which is initialized to count.
 
ISemThreadSupport.pend( )  // per-instance
index URL

Wait for the semaphore to become available

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
Int pend( UInt timeout, Error.Block *eb );
 
ARGUMENTS
timeout — timeout in microseconds
eb — error block
DETAILS
RETURNS
refer to description above
 
ISemThreadSupport.post( )  // per-instance
index URL

Increment the semaphore count

XDCspec declarations sourced in xdc/runtime/knl/ISemThreadSupport.xdc
Bool post( Error.Block *eb );
 
ARGUMENTS
eb — error block
RETURNS
true for success, false for error in error block
 
per-instance convertors
index URL

C synopsis target-domain
ISemaphore_Handle ISemThreadSupport_Handle_upCast( ISemThreadSupport_Handle handle );
// unconditionally move one level up the inheritance hierarchy
 
ISemThreadSupport_Handle ISemThreadSupport_Handle_downCast( ISemaphore_Handle handle );
// conditionally move one level down the inheritance hierarchy; NULL upon failure
generated on Thu, 25 Jun 2009 21:46:10 GMT