ASAP 1.1 Hybrid Manual

HP NonStop ASAP Hybrid Manual – 529729-004
Page 4-7
API Details
This section describes each of the ASAP Hybrid for Linux API procedure calls in
detail.
asap_register
Register a new domain with ASAP. This procedure must be called once for each
domain before you attempt to update data items for that domain. Once a
domain has been successfully registered, the application can use the other ASAP
Hybrid library procedures to update information for the domain, including data
items and operational state and text.
An application can register as many domains as needed, but each domain name
must be unique within ASAP. The application must also maintain the shared
memory handle returned for each domain in order to be able to update and
eventually remove that domain.
Declaration
short asap_register (
const char *ptr_domain_name, // IN REQUIRED
// App domain name being registered
void **ptr_handle, // OUT REQUIRED
// Shared memory handle for this domain
short *ptr_error_detail = NULL, // OUT OPTIONAL
// Detailed error number, if any
const char *ptr_asap_id = NULL, // IN OPTIONAL
// ASAP ID to register into
const bool rank_enabled_ind = true, // IN OPTIONAL
// Rank enabled flag
const bool concat_ind = true, // IN OPTIONAL
// PID concatenation indicator
const int io_timeout = 2000, // IN OPTIONAL
// Registration timeout value
const char *ptr_version = NULL // IN OPTIONAL
// Process/application version ID
);
Parameter Descriptions
const char *ptr_domain_name
A unique identifier for the application domain. The domain name is a logical
representation of the application work being performed. Domain names must
follow these rules: