Message Queue Developer's Guide for C Clients Release 5.0
Total Page:16
File Type:pdf, Size:1020Kb
Open Message Queue Developer's Guide for C Clients Release 5.0 May 2013 This guide provides programming and reference information for developers working with Message Queue who want to use the C language binding to the Message Queue Service to send, receive, and process Message Queue messages. Open Message Queue Developer's Guide for C Clients, Release 5.0 Copyright © 2013, 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 RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065. 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. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 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 Preface ................................................................................................................................................................ vii 1 Introduction Message Queue for the C Developer.................................................................................................... 1-1 Building and Running C Clients........................................................................................................... 1-2 Building C Clients .............................................................................................................................. 1-2 Providing Runtime Support ............................................................................................................. 1-3 Working With the Sample C-Client Programs.................................................................................... 1-4 Basic C-Client Programs ................................................................................................................... 1-4 Distributed Transaction Sample Programs .................................................................................... 1-5 Client Application Deployment Considerations ............................................................................... 1-7 2 Using the C API Message Queue C Client Setup Operations........................................................................................ 2-1 To Set Up a Message Queue C Client to Produce Messages ....................................................... 2-1 To Set Up a Message Queue C Client to Consume Messages Synchronously.......................... 2-2 To Set Up a Message Queue C Client to Consume Messages Asynchronously ....................... 2-2 Working With Properties ........................................................................................................................ 2-3 Setting Connection and Message Properties.................................................................................. 2-3 Getting Message Properties.............................................................................................................. 2-4 Working With Connections .................................................................................................................... 2-6 Defining Connection Properties....................................................................................................... 2-7 Working With Secure Connections ................................................................................................. 2-8 Shutting Down Connections.......................................................................................................... 2-11 Working With Sessions and Destinations........................................................................................ 2-11 Creating a Session ........................................................................................................................... 2-11 Managing a Session......................................................................................................................... 2-13 Creating Destinations ..................................................................................................................... 2-13 Working With Messages ...................................................................................................................... 2-14 Composing Messages ..................................................................................................................... 2-14 Sending a Message.......................................................................................................................... 2-16 Receiving Messages ........................................................................................................................ 2-18 Processing a Message ..................................................................................................................... 2-20 Working With Distributed Transactions........................................................................................... 2-20 Message Queue Resource Manager Information ....................................................................... 2-21 iii Programming Examples................................................................................................................. 2-22 Error Handling....................................................................................................................................... 2-22 To Handle Errors in Your Code .................................................................................................... 2-22 Memory Management .......................................................................................................................... 2-22 Logging.................................................................................................................................................... 2-23 3 Client Design Issues Producers and Consumers ...................................................................................................................... 3-1 Using Selectors Efficiently ..................................................................................................................... 3-2 Determining Message Order and Priority........................................................................................... 3-2 Managing Threads ................................................................................................................................... 3-3 Message Queue C Runtime Thread Model .................................................................................... 3-3 Concurrent Use of Handles .............................................................................................................. 3-3 Single-Threaded Session Control....................................................................................................