OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

ManualsBrandsHP ManualsServerHP NonStop G-Series

Introduction to the GPI

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

1-3

Gateway Interface Programs

A typical client program processes inbound and outbound information. The GPI

procedures enable you to perform the following functions:

•

Initialize the GPI environment in which your client application program is to

operate.

•

Open and close sessions between your program and the GPI service.

•

Create messages, probes, and reports and transfer them out to an OSI/MHS MTA by

way of the GPI service’s output queue.

•

Transfer messages, probes, and reports in from an OSI/MHS MTA by way of the

GPI service’s input queue and examine the objects you have received.

•

Request detailed status information when you detect an error or failure of a

procedure.

The following description of how the procedures are used provides an overview only.

For detailed information about the design of a client program and examples of actual

programs, see the OSI/MHS Gateway Programmatic Interface (GPI) Programming

Guide.

GPI Initialization

Before calling any other GPI procedures, you must initialize the GPI environment by

calling the GPI_INITIALIZE_ procedure. Using this procedure, you specify

characteristics about the environment, such as the disk volume to be used for the GPI

extended data segment and limits on the sizes of tables and string values.

Gateway Sessions

Before you can gain access to an OSI/MHS MTA, you open a session by calling the

GPI_OPEN_ procedure. A client process (executing client program) can have at most

15 sessions open at the same time.

When opening a session, you specify the following characteristics:

•

Information about the gateway through which you are communicating. You specify

the name of the GATEWAY object, as configured by the system manager or operator

using Distributed Systems Management (DSM), and a gateway password. For more

information about GATEWAY objects, see the OSI/MHS Configuration and

Management Manual and the SCF Reference Manual for OSI/MHS.

•

The name of the MHS manager process that controls the gateway of which your

program is part.

•

A gateway instance name that uniquely identifies a session, which is typically

sharing the gateway (and its input and output queues) with other sessions. You can

use this name as a logging or tracing mechanism or for archiving and auditing

gateway activity.