OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-14
GPI_MT_START_TRANSFER_IN_
tag input
INT(32)
is a reserved parameter and should not be specified.
max-in-memory-string-len input
INT(32)
specifies the maximum length for a string that the Gateway Interface Process can
write to the in-memory string area. Strings of a greater length are written to a
temporary file.
The minimum value you can assign to
max-in-memory-string-len is 512
bytes. The maximum value is 8 megabytes. The default value is 8 megabytes.
Considerations
•
If the input queue contains several unreserved objects, the GPI service decides
which one to reserve on the basis of its priority and, within a priority, on its arrival
time. Higher-priority items received at the earliest time are reserved first. If all
objects in the input queue are reserved, or there are no objects in the queue, an error
is returned.
•
While you have an object 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.
•
The GPI allows a client program to process at most 15 root objects at a time,
regardless of the number of open sessions. The root objects can be a combination of
reserved root objects and newly created root objects. The limit is also affected by the
size of the objects. For more information, see GPI_INITIALIZE_
on page 4-7
When your program reaches this limit, you cannot make another call to
GPI_MT_START_TRANSFER_IN_ until you remove a reserved object by calling
GPI_MT_FINISH_TRANSFER_IN_ , you transfer a root object out to the GPI
service output queue, or you delete a root object.
•
When an error occurs, the GPI attempts to return as much information as possible.
For example, a partial communication is returned, if a mapping problem occurs
during processing of an inbound message. No communication is returned if an error
is detected before an inbound communication is processed.
If a full communication is returned, the status value is OM-RC-SUCCESS or
OM-RC-TEMPORARY-ERROR. If a partial communication, or no communication,
is returned, the status value is OM-RC-PERMANENT-ERROR.
A full or partial communication is assigned a valid object identifier. If no
communication is returned, the object identifier is ZGPI-NULL-OBJ-ID.
•
The Gateway Interface Process (GIP)does not write strings exceeding the maximum
value for max-in-memory-string-len into the in-memory string table.