Oracle® Tuxedo Programming an Oracle Tuxedo Application Using COBOL 12c Release 2 (12.2.2) April 2016 Oracle Tuxedo Programming an Oracle Tuxedo Application Using COBOL, 12c Release 2 (12.2.2) Copyright © 1996, 2016, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Contents 1. Introduction to Oracle Tuxedo Programming Oracle Tuxedo Distributed Application Programming . 1-1 Communication Paradigms . 1-2 Oracle Tuxedo Clients. 1-4 Oracle Tuxedo Servers . 1-5 Basic Server Operation . 1-6 Servers as Requesters. 1-7 Oracle Tuxedo API: ATMI . 1-7 2. Programming Environment Updating the UBBCONFIG Configuration File . 2-1 Setting Environment Variables . 2-5 Defining Equivalent Data Types. 2-9 Starting and Stopping the Application . 2-10 3. Managing Typed Records Overview of Typed Records . 3-1 Defining Typed Records . 3-6 Using a VIEW Typed Record . 3-7 Setting Environment Variables for a VIEW Typed Record . 3-7 Creating a View Description File. 3-8 Executing the VIEW Compiler . 3-11 Using an FML Typed Record . 3-13 Programming an Oracle Tuxedo Application Using COBOL iii Setting Environment Variables for an FML Typed Record . 3-14 Creating a Field Table File . 3-14 Initializing a Typed Record. 3-16 Creating an FML Header File . 3-19 Using an XML Typed Record . 3-20 4. Writing Clients Joining an Application . 4-1 Using Features of the TPINFDEF-REC Record . 4-3 Client Naming . 4-4 Unsolicited Notification Handling . 4-5 System Access Mode . 4-6 Resource Manager Association. 4-7 Client Authentication . 4-7 Leaving the Application . 4-8 Building Clients . 4-8 See Also . 4-10 Client Process Examples . 4-10 5. Writing Servers Oracle Tuxedo System Controlling Program . 5-1 System-supplied Server and Services. 5-3 System-supplied Server: AUTHSVR( ) . 5-3 System-supplied Services: TPSVRINIT Routine . 5-3 Receiving Command-line Options. 5-4 Opening a Resource Manager . 5-6 System-supplied Services: TPSVRDONE Routine . 5-8 Guidelines for Writing Servers. 5-9 iv Programming an Oracle Tuxedo Application Using COBOL Defining a Service . 5-11 Terminating a Service Routine . 5-19 Sending Replies . 5-19 Invalidating Descriptors . 5-25 Forwarding Requests . 5-26 Advertising and Unadvertising Services. 5-29 Advertising Services . 5-30 Unadvertising Services . 5-30 Example: Dynamic Advertising and Unadvertising of a Service . 5-31 Building Servers . 5-32 See Also. 5-34 6. Writing Request/Response Clients and Servers Overview of Request/Response Communication . 6-1 Sending Synchronous Messages. 6-2 Example: Using the Same Record for Request and Reply Messages . 6-3 Example: Sending a Synchronous Message with TPSIGRSTRT Set . 6-6 Example: Sending a Synchronous Message with TPNOTRAN Set . 6-8 Sending Asynchronous Messages. 6-10 Sending an Asynchronous Request . 6-11 Getting an Asynchronous Reply . 6-14 Setting and Getting Message Priorities. 6-15 Setting a Message Priority. 6-15 Getting a Message Priority . 6-17 7. Writing Conversational Clients and Servers Overview of Conversational Communication . 7-1 Joining an Application . 7-3 Programming an Oracle Tuxedo Application Using COBOL v Establishing a Connection . 7-3 Sending and Receiving Messages . 7-4 Sending Messages . 7-5 Receiving Messages.