This document covers the following topics:
This section provides the programmer with reference material on the RPC Communication Area. The RPC communication area is used to specify parameters which are needed to communicate with the broker and are not specific to interface objects. These are, for example, the broker ID, client parameters such as user ID, password and the server address such as class/servername/service etc.
The RPC communication area is provided in include file RPCCOM.
| RPC Communication Area Field | Explanation | Req. Opt. Auto |
In Out | Notes |
|---|---|---|---|---|
COM_EYECATCHER |
Internal use only - not for customer use. | - | - | 1 |
COM_VERSION |
Version of RPC Communication Area. | Req. | I | 2 |
COM_SIZE |
Size of RPC Communication Area. | Req. | I | 2 |
COM_FUNCTION |
LO - Logon to broker.
|
Opt | I | 3 |
LF - Logoff from broker.
|
Opt | I | 3 | |
OC - Open Conversation.
|
Opt | I | 4 | |
CB - Close Conversation.
|
Opt | I | 4 | |
CE - Close Conversation and Commit.
|
Opt | I | 4 | |
COM_ERROR |
Error code and error text returned by PL/I Wrapper. | - | O | 5 |
COM_BROKER_ID |
Broker ID used. Corresponds to the BROKER-ID field of the control block.
|
Req. | I | 6 |
COM_SERVER_CLASS |
Class Name of the RPC server. Use "RPC" for
Natural RPC Server. Corresponds to the SERVER-CLASS field of the ACI control block.
|
Req. | I | 6 |
COM_SERVER_NAME |
Server Name of the RPC server. Corresponds to the SERVER-NAME field of the ACI control block.
|
Req. | I | 6 |
COM_SERVER_SERVICE |
Service Name of the RPC server. Use "CALLNAT"
for Natural RPC Server. Corresponds to the SERVICE field of the ACI control block.
|
Req. | I | 6 |
COM_SERVER_LIBRARY |
Library sent to the RPC server. The library specified here overrides any library information specified in the IDL file, see library-definition. | Opt | I | 4,7 |
COM_SERVER_CONVID |
Conversation ID if in an RPC Conversation.
Corresponds to the CONV-ID field of the ACI control block.
|
Auto | - | 4 |
COM_SERVER_WAIT |
Gives the time-out value for the transport
system in seconds. Corresponds to the WAIT field of the ACI control
block.
|
Opt | I | 7 |
COM_CLIENT_USERID |
Broker user identification. Corresponds to the
USER-ID field of the ACI control block.
|
Req. | I | 3,6 |
COM_CLIENT_TOKEN |
Token used by the broker to identify the caller.
Corresponds to the TOKEN field of the ACI control block.
|
Opt | I | 3,7 |
COM_CLIENT_PASSWORD |
Password to be transmitted to the broker to
check authentication. Corresponds to the PASSWORD field of the ACI control
block.
|
Opt | I | 3,7 |
COM_CLIENT_SECTOKEN |
Broker security token. Received also from broker
and assigned to this field for further use. Corresponds to the SECURITY-TOKEN field of the control block.
|
Auto | I | 8 |
COM_CLIENT_RPCUSERID |
RPC user ID, provided to Natural Security. | Opt | I | 7,9 |
COM_CLIENT_RPCPASSWORD |
RPC password provided to Natural Security. | Opt | I | 7,9 |
COM_CLIENT_CODEPAGE |
In this field you can assign a codepage for character conversion. For more information see Using Internationalization with the PL/I Wrapper. | Opt | I | 10 |
COM_CLIENT_BROKERLOGON |
Internal use only - not for customer use. | - | - | 1 |
COM_CLIENT_NATSECURITY |
Flag signaling a Natural Security ticket has to be provided with interface object calls. | Opt | I | 7,9 |
COM_DATA_FILLED |
Internal use only - not for customer use. | - | - | 1 |
COM_DATA_MAXLEN |
Internal use only - not for customer use. | - | - | 1 |
COM_DATA_NCHUNK |
Number of chunks allocated as a minimum, used by memory allocation. | Opt | I | 7,11 |
COM_DATA_SCHUNK |
Size of a chunk, used by memory allocation. | Opt | I | 7,11 |
COM_TRACE_LEVEL |
Internal use only - not for customer use. | - | - | 1 |
COM_TRACE_FCTLVL |
Internal use only - not for customer use. | - | - | 1 |
COM_TRACE_INDENT |
Internal use only - not for customer use. | - | - | 1 |
COM_DATA |
Internal use only - not for customer use. | - | - | 1 |
Name of the field in the RPC communication area.
Explanation of the purpose of the field.
Indicates for input fields whether they have to be given by the RPC application (required) or may be given (optional). Fields marked with Auto are managed internally by the interface objects and the generic RPC services module themselves.
Indicates whether the field is an input field (to be given by the RPC application), or an output field (returned to your RPC application).
Notes:
COM_DATA_SCHUNK whereby the needed number is adjusted automatically by
the interface object then. With the field COM_DATA_NCHUNK a minimum number of
blocks allocated is defined, which is used if the calculation by the interface
object gives a lower number than the minimum. The default minimum number (4
blocks) can be altered with the field COM_DATA_NCHUNK. Normally it is not
required to alter COM_DATA_SCHUNK and COM_DATA_NCHUNK fields.
Among the generated PL/I sources and include files, the following PL/I modules are delivered . Some of them are PL/I sources, some of them are PL/I include files.
| Module | Data Set | Description | Notes |
|---|---|---|---|
PLIDEF |
EXP101.INCL | Broker ACI control block for PL/I, referenced by the Generic RPC Services Modules | 1,5 |
RPCAPI |
EXP101.INCL | Generic RPC services interfaces | 4 |
RPCCOM |
EXP101.INCL | RPC communication area | 3 |
RPCDEF |
EXP101.INCL | Used internally by stubs and other parts | 1 |
RPCPPD |
EXP101.INCL | Preprocessor definitions | 1 |
RPCSRVI |
EXP101.INCL | Generic RPC services used internally | 1,5 |
RPCSRVS |
EXP101.INCL | Specific RPC functions used internally | 1,6 |
RPCSRVSB |
EXP101.INCL | Specific RPC functions used internally | 1 |
PLISRVIB |
EXP101.SRCE | Batch generic RPC services | 1,2,5 |
PLISRVIC |
EXP101.SRCE | CICS generic RPC services | 1,2,5 |
PLISRVS |
EXP101.SRCE | Specific RPC functions | 1,2,6 |
PLISRVT |
EXP101.SRCE | Trace functions module | 1,2,7 |
Name of the delivered module.
EXP101.QIPL - CICS RPC example include data set for PL/I.
The CICS RPC example include data set for PL/I may be delivered as a patch with a different name, EXP101.QInn, where nn is the patch level number. Make sure you install the highest patch level available.
EXP101.PIPL - Batch RPC example include data set for PL/I.
The Batch RPC example include data set for PL/I may be delivered as a patch with a different name, EXP101.PInn, where nn is the patch level number. Make sure you install the highest patch level available.
EXP101.INCL - Generic RPC include data set.
The Generic RPC include data set may be delivered as a patch with a different name, EXP101.INnn, where nn is the patch level number. Make sure you install the highest patch level available.
EXP101.SRCE - Generic RPC source data set.
The Generic RPC source data set may be delivered as a patch with a different name, EXP101.S0nn, where nn is the patch level number. Make sure you install the highest patch level available.
Purpose of the module.
Notes: