Contents

List of Tables

Title and Copyright Information

Preface

• Who Should Use This Book
• Before You Read This Book
• How This Book Is Organized
• Documentation Conventions
• Related Documentation
• Documentation, Support, and Training
• Documentation Accessibility

1 Introduction

• Message Queue for the C Developer
• Building and Running C Clients
  • Building C Clients
    • Header Files and Shared Libraries
    • Pre-Processor Definitions
    • C++ Runtime Library Support
  • Providing Runtime Support
• Working With the Sample C-Client Programs
  • Basic C-Client Programs
    • Building the Basic C-Client Sample Programs
    • Running the Basic C-Client Sample Programs
  • Distributed Transaction Sample Programs
    • To Set Up Tuxedo as a Distributed Transaction Manager
    • To Build the Distributed Transaction Sample Programs
    • To Run the Distributed Transaction Sample Programs
• Client Application Deployment Considerations

2 Using the C API

• Message Queue C Client Setup Operations
  • To Set Up a Message Queue C Client to Produce Messages
  • To Set Up a Message Queue C Client to Consume Messages Synchronously
  • To Set Up a Message Queue C Client to Consume Messages Asynchronously
• Working With Properties
  • Setting Connection and Message Properties
    • To Set Properties for a Connection
  • Getting Message Properties
    • To Iterate Through a Properties Handle
• Working With Connections
  • Defining Connection Properties
    • Connection Handling
    • Reliability
    • Flow Control
  • Working With Secure Connections
    • Configuring the Client for Secure Communication
    • Verification Using Fingerprints
    • Coordinating NSS Initialization
  • Shutting Down Connections
• Working With Sessions and Destinations
  • Creating a Session
    • Transacted Sessions
    • Message Acknowledgement
    • Receive Mode
  • Managing a Session
  • Creating Destinations
    • Programming Domains
    • Auto-Created Destinations
    • Temporary Destinations
    • Getting Information About Destinations
• Working With Messages
  • Composing Messages
    • Message Header
    • Message Body Types
    • Composing the Message
  • Sending a Message
  • Receiving Messages
    • Working With Consumers
    • Receiving a Message Synchronously
    • Receiving a Message Asynchronously
  • Processing a Message
• Working With Distributed Transactions
  • Message Queue Resource Manager Information
  • Programming Examples
• Error Handling
  • To Handle Errors in Your Code
• Memory Management
• Logging

3 Client Design Issues

• Producers and Consumers
• Using Selectors Efficiently
• Determining Message Order and Priority
• Managing Threads
  • Message Queue C Runtime Thread Model
  • Concurrent Use of Handles
  • Single-Threaded Session Control
  • Connection Exceptions
• Managing Physical Destination Limits
• Managing the Dead Message Queue
• Factors Affecting Performance
  • Delivery Mode (Persistent/Non-persistent)
  • Use of Transactions
  • Acknowledgement Mode
  • Durable and Non-Durable Subscriptions
  • Use of Selectors (Message Filtering)
  • Message Size
  • Message Type

4 Reference

• Data Types
  • Connection Properties
    • To Set Connection Properties
  • Acknowledge Modes
  • Callback Type for Asynchronous Message Consumption
    • Parameters
  • Callback Type for Asynchronous Message Consumption in Distributed Transactions
    • Parameters
  • Callback Type for Connection Exception Handling
    • Parameters
• Function Reference
  • MQAcknowledgeMessages
    • Return Value
    • Parameters
    • Common Errors
  • MQCloseConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQCloseMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
  • MQCloseMessageProducer
    • Return Value
    • Parameters
    • Common Errors
  • MQCloseSession
    • Return Value
    • Parameters
    • Common Errors
  • MQCommitSession
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateAsyncDurableMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateAsyncMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateBytesMessage
    • Return Value
    • Parameters
  • MQCreateConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateDestination
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateDurableMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateMessage
    • Return Value
    • Parameters
  • MQCreateMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateMessageProducer
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateMessageProducerForDestination
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateProperties
    • Return Value
    • Parameters
  • MQCreateSession
    • Return Value
    • Parameters
  • MQCreateTemporaryDestination
    • Return Value
    • Parameters
    • Common Errors
  • MQCreateTextMessage
    • Return Value
    • Parameters
  • MQCreateXASession
    • Return Value
    • Parameters
    • Common Errors
  • MQFreeConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQFreeDestination
    • Return Value
    • Parameters
  • MQFreeMessage
    • Return Value
    • Parameters
  • MQFreeProperties
    • Return Value
    • Parameters
  • MQFreeString
    • Return Value
    • Parameters
  • MQGetAcknowledgeMode
    • Return Value
    • Parameters
  • MQGetBoolProperty
    • Return Value
    • Parameters
    • Common Errors
  • MQGetBytesMessageBytes
    • Return Value
    • Parameters
  • MQGetConnectionProperties
    • Return Value
    • Parameters
  • MQGetDestinationName
    • Return Value
    • Parameters
  • MQGetDestinationType
    • Return Value
    • Parameters
  • MQGetErrorTrace
    • MQGetFloat32Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetFloat64Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetInt16Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetInt32Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetInt64Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetInt8Property
    • Return Value
    • Parameters
    • Common Errors
  • MQGetMessageHeaders
    • Return Value
    • Parameters
  • MQGetMessageProperties
    • Return Value
    • Parameters
    • Common Errors
  • MQGetMessageReplyTo
    • Return Value
    • Parameters
    • Common Errors
  • MQGetMessageType
    • Return Value
    • Parameters
  • MQGetMetaData
    • Return Value
    • Parameters
  • MQGetPropertyType
    • Return Value
    • Parameters
    • Common Errors
  • MQGetStatusCode
    • Parameters
  • MQGetStatusString
    • Parameters
  • MQGetStringProperty
    • Return Value
    • Parameters
  • MQGetTextMessageText
    • Return Value
    • Parameters
  • MQGetXAConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQInitializeSSL
    • Return Value
    • Parameters
    • Common Errors
  • MQPropertiesKeyIterationGetNext
    • Return Value
    • Parameters
  • MQPropertiesKeyIterationHasNext
    • Return Value
    • Parameters
  • MQPropertiesKeyIterationStart
    • Return Value
    • Parameters
  • MQReceiveMessageNoWait
    • Return Value
    • Parameters
    • Common Errors
  • MQReceiveMessageWait
    • Return Value
    • Parameters
    • Common Errors
  • MQReceiveMessageWithTimeout
    • Return Value
    • Parameters
    • Common Errors
  • MQRecoverSession
    • Return Value
    • Parameters
    • Common Errors
  • MQRollBackSession
    • Return Value
    • Parameters
    • Common Errors
  • MQSendMessage
    • Return Value
    • Parameters
    • Common Errors
  • MQSendMessageExt
    • Return Value
    • Parameters
    • Common Errors
  • MQSendMessageToDestination
    • Return Value
    • Parameters
    • Common Errors
  • MQSendMessageToDestinationExt
    • Return Value
    • Parameters
    • Common Errors
  • MQSetBoolProperty
    • Return Value
    • Parameters
    • Common Errors
  • MQSetBytesMessageBytes
    • Return Value
    • Parameters
  • MQSetFloat32Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetFloat64Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetInt16Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetInt32Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetInt64Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetInt8Property
    • Return Value
    • Parameters
    • Common Errors
  • MQSetMessageHeaders
    • Return Value
    • Parameters
    • Common Errors
  • MQSetMessageProperties
    • Return Value
    • Parameters
  • MQSetMessageReplyTo
    • Return Value
    • Parameters
  • MQSetStringProperty
    • Return Value
    • Parameters
  • MQSetTextMessageText
    • Return Value
    • Parameters
  • MQStartConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQStatusIsError
    • Parameters
  • MQStopConnection
    • Return Value
    • Parameters
    • Common Errors
  • MQUnsubscribeDurableMessageConsumer
    • Return Value
    • Parameters
    • Common Errors
• Header Files

A Message Queue C API Error Codes

• Error Codes