OSI/MHS Management Programming Manual

SPI Programming Considerations for OSI/MHS
OSI/MHS Management Programming Manual—424824-001
3-5
Event Numbers
The LISTOBJECTS command accepts object-name templates (wild-card names), which
designate a set of objects to be operated on by the command. Valid object-name
templates contain only the asterisk (*) wild-card character; the question mark character
(?) is not allowed. The object-name templates accepted by LISTOBJECTS for each
OSI/MHS object type are described in the LISTOBJECTS command descriptions in
Section 5, Commands and Responses
.
Event Numbers
All event messages contain a header token identifying the event by number. This event
number, in combination with the subsystem ID header token, uniquely identifies the
kind of event being reported. Event numbers for event messages defined by OSI/MHS
are identified by symbolic names of the form ZOSI-EVT-name, where name gives a
brief description of the event being reported.
In these event messages, the event-number header token (ZEMS-TKN-
EVENTNUMBER) can assume any one of the set of event numbers for OSI/MHS,
which are listed at the beginning of Section 6, Event Messages
. The OSI/MHS event
messages are described in Section 6, Event Messages
.
The OSI/MHS subsystem also generates ZCOM-defined event messages. These are
described in the SPI Common Extensions Manual.
Subject of Event Messages
The subject of an event message generated by the OSI/MHS subsystem is a token that
identifies a process. The subject token for the MHS manager is ZCOM-TKN-SUBJ-
MON. The subject token for any other part of the OSI/MHS subsystem is ZCOM-TKN-
SUBJ-PROC.
Other Tokens
Commands, responses, and event messages for OSI/MHS, like those for other
subsystems, also include other tokens providing further information. For further general
information about such tokens, their types, and the values that are predefined for some
of them, refer to the SPI Common Extensions Manual.
Data Lists and Error Lists
Responses from the OSI/MHS subsystem can contain data lists and error lists as
described in the SPI Programming Manual. However, note that OSI/MHS never returns
more than one data list per response message, even if the value of ZSPI-TKN-
MAXRESP is greater than 1.
Using SPI to Build Commands and
Decode Responses
The following subsections summarize the steps your application must take to create,
send, retrieve, and decode SPI messages. These summaries are followed by subsystem-
specific programming considerations for OSI/MHS.