OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-30
Initiating Transfer-in of a Root Object
Procedure call:
status := GPI_MT_WAIT_ ( session,
interval,
available);
Starting Transfer of an Inbound Root Object
You call the GPI_MT_START_TRANSFER_IN_ procedure to start the inbound
transfer. The call reserves a root object on the GPI service input queue and puts a copy
of the object in the GPI library memory space. As the copy passes through the GIP, it is
decoded into a form suitable for manipulation by GPI procedures. Figure 5-8 shows how
decoded root objects are transferred into the GPI library memory space. The copy is
unmodifiable; it can be inspected and copied but not changed.
While a root object is reserved, the GPI service continues to be responsible for it. By
reserving an object for a session, you prevent the object from being reserved again,
either by the same or another session.
Parameters for GPI_MT_START_TRANSFER_IN_ are:
session (input)
object (output)
encoded (input)
session specifies the identifier of the session in which the request for access to an
object is made.
object is the identifier assigned to the object reserved by this procedure. If no object
is available to be reserved, the value of this parameter is ZGPI-NULL-OBJ-ID .
Note. The time to complete GPI_MT_START_TRANSFER_IN_ is proportional to the size and
complexity of the root object being transferred.
Figure 5-8. Using GPI_MT_START_TRANSFER_IN_ With Decoded Root
Objects
508CDT .CDD
GPI Library Memory Space
Attribute
Attribute
Attribute
OBJECT
Attribute
GPI Service Input Queue
Root object
decoded into form
suitable for
manipulation by
GPI procedures
Message,
Probe, or Report