Class Index
static org.cote.js.driver.ApplicationDriver
version 1.9.6
Static instance of ApplicationDriverImpl.
This class participates in the engine library.
org.cote.js.driver.ApplicationDriverImpl
version 1.9.6
Driver for starting up and shutting down the framework.
This class participates in the engine library.
Index
Property Index
- public object_config (internal): Object API structure for storing sub structures: object_config.pointers and object_config.status.
- public object_id (internal): Unique instance identifier.
- public object_type (internal): The type of this object.
- public object_version (internal): Version of the object class.
- public ready_state (internal): Object load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.
Method Index
- private _terminate (internal): Publishes a destroy message to all subscribing objects.
- public destroy: Destroys this object, and if specified, sends a termination signal to all registered objects.
- public getConfig: Returns a org.cote.js.util.config object.
- public getObjectId: Returns the unique id of the object.
- public getObjectType: Returns the type of the object.
- public getObjectVersion: Returns the version of the object.
- public getPointers: Returns the object_config.pointers sub structure.
- public getReadyState: Returns the state of the object.
- public getStatus: Returns the object_config.status sub structure.
- public setConfig: Specifies the application configuration object. Causes the application_config_loaded message to be published.
- public sigterm: Sends termination signal to destroy object without propogating termination signal to other objects.
Properties
object_config
Object API structure for storing sub structures: object_config.pointers and object_config.status.
Syntax
object = object.object_config
object_id
Unique instance identifier.
Syntax
String = object.object_id
object_type
The type of this object.
Syntax
String = object.object_type
object_version
Version of the object class.
Syntax
String = object.object_version
ready_state
Object load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.
Syntax
int = object.ready_state
Methods
_terminate
Publishes a destroy message to all subscribing objects. Method is private and should not be directly referenced.
Syntax
void _terminate(
)
destroy
Destroys this object, and if specified, sends a termination signal to all registered objects.
Syntax
void destroy(
b
)
Parameters
- b as boolean : Bit indicating whether a termination signal should be sent to all registered objects.
getConfig
Returns a org.cote.js.util.config object.
Syntax
c = getConfig(
)
Returns
c as org.cote.js.util.config: Config object.
getObjectId
Returns the unique id of the object.
Syntax
i = getObjectId(
)
Returns
i as String: The unique object instance id.
getObjectType
Returns the type of the object.
Syntax
t = getObjectType(
)
Returns
t as String: The type of the object instance.
getObjectVersion
Returns the version of the object.
Syntax
v = getObjectVersion(
)
Returns
v as String: The version of the object instance.
getPointers
Returns the object_config.pointers sub structure.
Syntax
o = getPointers(
)
Returns
o as object: The object_config.pointers substructure.
getReadyState
Returns the state of the object.
Syntax
s = getReadyState(
)
Returns
s as int: The object ready state.
getStatus
Returns the object_config.status sub structure.
Syntax
o = getStatus(
)
Returns
o as object: The object_config.status substructure.
setConfig
Specifies the application configuration object. Causes the application_config_loaded message to be published.
Syntax
void setConfig(
c
)
Parameters
- c as org.cote.js.util.config : Config object.
sigterm
Sends termination signal to destroy object without propogating termination signal to other objects.
Syntax
void sigterm(
)