OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001

4-18

GPI_MT_WAIT_

This procedure monitors the input queue of the GPI service for a specified time interval

to determine whether any unreserved objects are available.

status returned value

INT:value

indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a

successful call. For additional values of status, see Appendix B, Return Codes

session input

INT:value

specifies the session identifier of the session that is monitoring the input queue.

interval input

INT(32):value

specifies the maximum interval of time (in 0.01-second units) that this procedure is

to wait for an unreserved object to be located in the input queue. The value can be as

follows:

available output

INT(32) .EXT:ref:1

is an indicator denoting whether an available unreserved object has been detected on

the input queue.

The value can be:

status := GPI_MT_WAIT_ ( session ! I

, interval ! I

, available ) ; ! O

= -1 Wait indefinitely for an available unreserved object.

= 0 Return immediately even if an unreserved object is not available currently.

> 0 Wait for a maximum of the specified number of 0.01-second units for an

available unreserved object.

OM-TRUE indicates that an unreserved object is available.

OM-FALSE indicates that no unreserved objects are available.