Envoy Application Programming Manual

Table Of Contents
Application Programming With Envoy
Envoy Application Programming Manual427159-001
1-9
Object Types
Like all other subsystems that support DSM, Envoy defines a set of object types—the
kinds of objects that can be managed by Envoy—and a set of commands that can be
performed on objects of these types.
Object Types
The WAN subsystem contains several SCF objects. Envoy uses the DEVICE, PROFILE,
PROCESS and LINE objects.
PROFILE
The PROFILE object is a user-created, SCF object containing default modifier values
pertaining to the communications line. You build the PROFILE object from disk files, or
templates, which come with the Envoy product. These disk files come with default
modifier values for each communications protocol ($ENV01, $ASCA, $BSCA, and so
on).
DEVICE
For Envoy, the DEVICE object represents the line-handler process. Starting the
DEVICE object in the WAN subsystem launches the line-handler process object in the
Envoy subsystem. The line-handler process inherits the DEVICE object’s modifier and
attribute definitions.
The DEVICE object has attributes specifying how the DEVICE runs as a process, such
as which CPU the process runs in and which concentrator the process uses. One
specifiable attribute of the DEVICE object is the PROFILE object.
PROCESS
A PROCESS object defines an Envoy line handler. PROCESS object names must take
the format $Axxxxxx where A is an alphabetic character and xxxxxx is up to six
alphanumeric characters. The PROCESS object name is the same as the corresponding
LINE object name and must be unique within a system. An example is $ENV1.
LINE
A LINE object defines a communications line controlled by Envoy and is named
automatically with the same name as the PROCESS object. LINE object names must
take the format of $Axxxxxx, where A is an alphabetic character and xxxxxx is up to six
alphanumeric characters.) An example is $ENV1.
LINE objects can be in the STARTED, STOPPED, or SUSPENDED states.
Commands
Envoy commands are available in interactive form through SCF and in programmatic
form (as SPI messages). Table 1-2
shows the correspondence between the interactive
SCF commands and the programmatic commands sent by management applications.