APIs for Use with Natural RPC

The purpose of Natural Application Programming Interfaces (API) is to retrieve or modify information or use services that are not accessible by Natural statements. The following Application Programming Interfaces available in the Natural library SYSEXT are intended for being used with the Natural RPC. Entries with a hyperlink correspond to APIs that are documented in the Natural documentation.

You can also find a description of an API in library SYSEXT under the name USRnnnnT or in the SYSEXT utility with the line command T for a required API.

For a list of all RPC-relevant APIs, enter the keyword RPC in the Keyword field in the SYSEXT utility.

For more information about how to use a Natural API, see SYSEXT Utility - Natural Application Programming Interfaces.

API Purpose
USR1071N Set credentials for RPC server: user ID, password and ticket criteria for Natural RPC.

Send logon data to the Natural RPC server if the client has no NSC, or if the client has NSC: for using a different user ID and password on server side.

See Using Security.

For an enhanced version of this API, refer to API USR9171N.

USR2007N Get or set data for RPC default server, including the logon option.

Specify a default server address that is to be used each time a remote program cannot be addressed via the service directory.

See Specifying a Default Server Address within a Natural Session in Operating a Natural RPC Environment.

USR2032N Support the commit for a CLOSE CONVERSATION statement on the client side. When called, this API will cause an implicit END TRANSACTION at the end of the individual conversation.

See Database Transactions in Introducing Natural RPC, section Conversational CALLNAT.

USR2035N Get or set parameters for SSL support.

Set the required SSL parameter string if the Secure Socket Layer (SSL) for the TCP/IP communication to the EntireX Broker is used.

See Using Secure Socket Layer in Operating a Natural RPC Environment.

USR2071N Support EntireX Security on client side. Logon to EntireX Broker.

Has to be called in case of non-Natural Security clients for specifying logon data which are then passed to the server.

See Using Natural RPC with Natural Security in Using Security.

USR2072N Support EntireX Security on server side.

Specify a password which is used for the LOGON in conjunction with keyword subparameter SRVUSER of the profile parameter RPC or the parameter macro NTRPC.

See Server Side in Using Security, section Using Natural RPC with EntireX Security.

USR2073N Ping or terminate a Natural RPC server from within your application.

See Using Application Programming Interface USR2073N in Terminating a Natural RPC Server.

For an enhanced version of this API, refer to API USR9175N.

USR2074N Change the Natural Security password on the RPC server via a Natural RPC service request.

See Change Password in Using Security.

USR2075N Terminate an EntireX Broker Service from within your application.

See Using Application Programming Interface USR2075N in Terminating a Natural RPC Server.

For an enhanced version of this API, refer to USR8208N and USR9176N.

USR2076N Get or set RPC TIMEOUT value.

See Get or Set RPC TIMEOUT Value Using API USR2076N in Operating a Natural RPC Environment.

USR4008N On the client side, pass an alternate name of a library to the Natural RPC server to log on to.

See Logging on to a Different Library in Operating a Natural RPC Environment.

USR4009N Set or get parameters for EntireX in a Natural RPC client or server environment.

See Setting/Getting Parameters for EntireX in Operating a Natural RPC Environment.

USR4010N On the client side, retrieve the runtime settings of a server.

See Retrieving the Runtime Settings of a Server in Operating a Natural RPC Environment.

USR4012N Set application error on RPC server.

See Set Application Error on RPC Server in Setting Up a Natural RPC Environment.

USR4371N On the client side, set the user ID and ETID for Natural RPC servers which were configured with Impersonation = A (automatic logon).

See Using Natural RPC with Natural Security in Using Security.

USR6304N Set or get the reliable state for the reliable Natural RPC.

See Reliable RPC on the Natural RPC Client Side in Reliable RPC.

USR6305N Commit or roll back a unit of work that has been created with CLIENT_COMMIT.

This API is required if the reliable RPC state has been set to client commit.

See Reliable RPC on the Natural RPC Client Side in Reliable RPC.

USR6306N Get the status of all reliable RPC messages of the user who is currently logged on to the EntireX Broker.

See Reliable RPC on the Natural RPC Server Side in Reliable RPC.

USR8208N Terminate an EntireX Broker service.

Pings or terminates an RPC server or terminates an EntireX Broker service. Displays the EntireX Broker version and other information from the EntireX Broker Command and Information Service (CIS). Enhanced version of USR2075N with the use of the more performant ‘shutdown service’ command on EntireX.

See Using Application Programming Interface USR8208N in Terminating a Natural RPC Server.

For an enhanced version of this API, refer to API USR9176N.

USR8213N Shutdown server with sequence number on EntireX Broker.

Retrieves a list of RPC server replica registered on a specified EntireX Broker. The interface then sends a shutdown request with the sequence number to the EntireX Broker.

See Using Application Programming Interface USR8213N in Terminating a Natural RPC Server.

For an enhanced version of this API, refer to API USR9177N.

USR8216N Maintain the RPC service directory.

See Service Directory Maintenance in SYSRPC Utility.

USR8220N Trigger the server-side termination of the Natural RPC server that is running this API.

See Using Application Programming Interface USR8220N in Terminating a Natural RPC Server.

USR8225N Maintain message ID and correlation ID of EntireX.

See Maintain Message ID and Correlation ID of EntireX in Operating a Natural RPC Environment.

USR9171N Set user's password phrase.

Set credentials for RPC server. Enhanced version of USR1071N with the capability of using longer passwords.

See Using Natural RPC with Natural Security in Using Security.

USR9175N Ping, terminate, or trace a Natural RPC server.

Enhanced version of API USR2073N with the capability of using longer passwords and getting or setting the trace level of a Natural RPC server.

See Using Application Programming Interface USR9175N in Terminating a Natural RPC Server.

USR9176N Terminate an EntireX Broker service.

Enhanced version of USR8208N with the capability of using longer passwords.

See Using Application Programming Interface USR9176N in Terminating a Natural RPC Server.

USR9177N Shutdown server with sequence number on EntireX Broker.

Enhanced version of USR8213N with the capability of using longer passwords.

See Using Application Programming Interface USR9177N in Terminating a Natural RPC Server.

USR9204N Send Command to Natural RPC server with sequence number on EntireX Broker.

See Sending Command to RPC Server in Operating a Natural RPC Environment.

Note that the RPC-specific APIs accept all values also in mixed mode. An uppercase translation will take place only if the example program USRnnnnP (source object) is used to invoke the corresponding subprogram USRnnnnN. Exception: All USRnnnnP programs that deal with passwords provide an option to enter the passwords in mixed case mode.