SNAX/HLS Management Programming Manual

Objects
Elements of SPI Messages for SNAX/HLS
104708 Tandem Computers Incorporated 4–5
The SUB Modifier
SNAX/HLS accepts the SUB modifier in all commands. Because sessions are
considered subordinate to the SNAX/HLS process, you can affect all sessions by
specifying that a command apply to all objects subordinate to the SNAX/HLS process.
You specify the subordinate modifier by using ZCOM–TKN–SUB. The enumerated
values for this token are:
ZCOM–VAL–SUB–ALL
specifies that the command must affect the named object and all the subordinate
objects, if any.
ZCOM–VAL–SUB–NONE
specifies that the named object, but none of the subordinate objects, is affected by
the command. This is equivalent to excluding the SUB modifier from the
command.
ZCOM–VAL–SUB–ONLY
specifies that the command refers only to the subordinate objects, if any. The
named object is not included.
ZCOM–OBJ–SESSION
specifies that only sessions subordinate to the named process are affected. This
value obtains results equivalent to specifying the value ZCOM–VAL–SUB–ONLY
when the command is addressed to the PROCESS object.
For example, assume a SNAX/HLS process (named $A) has two subordinate
sessions (named $A.#L.B and $A.#L.C). If the command ZCOM–CMD–INFO is
issued to the process $A, and the command includes ZCOM–TKN–SUB with the
value ZCOM–VAL–SUB–ONLY, only information on the sessions $A.#L.B and
$A.#L.C is returned.
The SEL–SUMSTATE Modifier
SNAX/HLS supports the use of the ZCOM–TKN–SEL–SUMSTATE modifier in all
commands. This modifier allows the requester to include or exclude the application of
a command to objects, based on the summary states of those objects. Descriptions of
the summary states for SNAX/HLS are included in the following subsection.
If the ZCOM–TKN–SUB modifier is included in a command with
ZCOM–TKN–SEL–SUMSTATE, the objects selected are based upon the value of
ZCOM–TKN–SUB and the target object of the command. For example, if a command is
addressed to a set of sessions identified by the object name template and the command
includes the token ZCOM–TKN–SEL–SUMSTATE with the value
ZCOM–VAL–SEL–SUMSTATE–STARTED TRUE, the command is applied to only those
sessions that are started and whose names match the template.