ASAP 1.1 Hybrid Manual

HP NonStop ASAP Hybrid Manual 529729-004
Page 4-12
asap_remove and asap_remove_ts
Removes a domain from the list of domains monitored by ASAP. This procedure
must be called whenever ASAP is to stop monitoring a given domain. This
procedure affects active monitoring only. It does not remove historical data from
the ASAP database.
When a domain is removed, ASAP writes a final record for the domain to the
ASAP database and then cleans up all resources associated with that domain.
The domain is not monitored from that point forward unless it is reregistered by
the application. For online applications, asap_remove should generally need to
be called only when the application is shut down. The exception is for domains
that are more transient in nature, which might be registered, update values, and
then be removed when a given unit of work has been completed.
Important note: A record is written to the ASAP database for each registered
domain every sample interval. If a domain has not been updated in an interval, it
is marked as inactive by ASAP, and alerts might optionally be generated. To
avoid spurious warnings of this type, applications should remove domains that
no longer need to be monitored. On the other hand, if a domain is simply
entering a dormant state for some period of time, the asap_control API
procedure can be used to temporarily disable ranking for that domain.
Declaration
short asap_remove (
void *handle, // IN REQUIRED
// Shared memory handle for this domain
short *ptr_error_detail = NULL, // OUT OPTIONAL
// Detailed error number, if any
const bool deallocate_ind = true // IN OPTIONAL
// Deallocation indicator
);
short asap_remove_ts (
void *handle, // IN REQUIRED
// Shared memory handle for this domain
short *ptr_error_detail = NULL, // OUT OPTIONAL
// Detailed error number, if any
const bool deallocate_ind = true // IN OPTIONAL
// Deallocation indicator
);
Parameter Descriptions
void *handle