HPOM Interface API

This API provides access to the HPOM Interfaces. HPOM for Windows provides the following interfaces:

• HPOM Message Stream Interface

  This interface makes it possible to read HPOM messages from the internal message stream and to write messages into the internal message stream. The Message Stream Interface (MSI) is available on the HPOM Managed Nodes. All MSI types establish a connection to the HPOM message agent. This interface is divided into the types:

  • OPCAGTIF_EXTMSGPROC_READ

    This interface type is used for non-destructive read operations on the HPOM internal message flow. Only messages that are allowed to be output on the Agent MSI are accessible using this interface type. This type of interface is typically used by statistical analysis tools or additional display facilities.

  • OPCAGTIF_EXTMSGPROC_READWRITE

    This interface type is used to read messages from HPOM's internal message flow, to modify / create messages, and to write them back to the HPOM processes. Only messages which are allowed to be output on the MSI are accessible using this interface type. Messages tagged with 'copy to' remain in HPOM's message flow, whereas messages tagged with 'divert to' are taken out of the flow. This type of interface could be used by event correlation engines.

  • OPCAGTIF_EXTMSGPROC_WRITE

    Interface instances of this type are used for write-only applications, to feed messages into HPOM's message flow. This type of interface could also be used to encapsulate the opcif_write() routine in a command line interface.

Prerequisites

The API functions must be issued by the agent user.

Multithread Usage

All functions of the Interface API are safe to be called by multithreaded applications and are thread safe for both POSIX Threads and DCE User Threads. They are neither async-cancel, async-signal, nor fork-safe, and cannot be called safely i kernel threads.

opcreg_copy() is not thread safe for POSIX threads or for DCE User Threads.

Registration conditions of the HPOM Interface API

HPOM provides a user-accessible data type to define registration conditions as the mechanism to register with the HPOM Interfaces.

HPOM provides a set of APIs to create an empty condition, modify or query condition fields and to duplicate or delete a condition definition from memory.

Related Topics:

• Security considerations for the HPOM Interface API