Global Call API for HMP on Windows Programming Guide — August 2006 111
Real Time Configuration Management
9.2.1 Customer Application Using Global Call RTCM
The customer application interfaces with the Global Call RTCM Manager via Global Call RTCM
API functions. The primary function of an application with regards to RTCM is the maintenance of
parameter data. It is the application developer’s responsibility to understand the impact on system
operation before changing a parameter value. Specifically, the application developer is responsible
for the following:
•Obtaining the information about run-time configuration support from the appropriate Global
Call Technology Guide.
•Ensuring that the configurable parameters match the target entity and inserting parameter data
in the proper data format.
•Choosing the proper Global Call RTCM API control parameters (programming mode, update
condition, and timeout) to ensure the efficiency of the retrieve or update configuration process
and that the application program is not blocked.
•Obtaining the configuration data from Global Call RTCM retrieval events.
•Correcting errors in input configurable parameter data based on the Global Call error
messages.
9.2.2 Global Call RTCM
The Global Call RTCM acts as an interface between the customer application and the
configurations of the target objects. A target object is a configurable basic entity and is represented
by its target type and target ID (for more information, see Section 1.5.4, “Target Objects”, on
page 25).
As mentioned before, the Global Call RTCM comprises the RTCM Manager and the RTCM API
functions.
The RTCM Manager is responsible for configuring components, including the Global Call Library
(GCLib), Call Control Library (CCLib), protocol, and firmware parameters (see Section 9.3,
“Using RTCM Parameters”, on page112).
The RTCM API functions are used to get, set, or query configuration parameters (consisting of a
specified target object and the configuration data) from the customer application to the software
module where the target object is located. The Global Call RTCM maintains the information about
a target object with its associated software module so that the Global Call RTCM can call the
appropriate software module to execute the configuration request. The Global Call RTCM also
assigns a unique ID for each request and outputs it to the application. The ID is used by the
application for tracking function calls.
Note: When using IP technology, only the gc_SetConfigData() function is supported. This function is
supported in asynchronous mode and can operate on a board device only.
In addition, the Global Call RTCM returns an error value when the function returns in synchronous
mode or generates a Global Call event related to the Global Call RTCM in asynchronous mode.
Since the Global Call RTCM may not have any knowledge about configurable parameters defined
or used in individual modules, it passes the configuration request to the software module in which