An application uses a message producer to send messages to a destination.
For a list of the XMS defined properties of a MessageProducer object, see Properties of MessageProducer.
Function | Description |
---|---|
xmsMsgProducerClose | Close the message producer. |
xmsMsgProducerGetDeliveryMode | Get the default delivery mode for messages sent by the message producer. |
xmsMsgProducerGetDestination | Get the destination for the message producer. |
xmsMsgProducerGetDisableMsgID | Get an indication of whether a receiving application requires message identifiers to be included in messages sent by the message producer. |
xmsMsgProducerGetDisableMsgTS | Get an indication of whether a receiving application requires time stamps to be included in messages sent by the message producer. |
xmsMsgProducerGetPriority | Get the default priority for messages sent by the message producer. |
xmsMsgProducerGetTimeToLive | Get the default length of time that a message exists before it expires. |
xmsMsgProducerSend | Send a message to the destination that was specified when the message producer was created. Send the message using the message producer's default delivery mode, priority, and time to live. |
xmsMsgProducerSendDest | Send a message to a specified destination if you are using a message producer for which no destination was specified when the message producer was created. Send the message using the message producer's default delivery mode, priority, and time to live. |
xmsMsgProducerSendDestWithAttr | Send a message to a specified destination if you are using a message producer for which no destination was specified when the message producer was created. Send the message using the specified delivery mode, priority, and time to live. |
xmsMsgProducerSendWithAttr | Send a message to the destination that was specified when the message producer was created. Send the message using the specified delivery mode, priority, and time to live. |
xmsMsgProducerSetDeliveryMode | Set the default delivery mode for messages sent by the message producer. |
xmsMsgProducerSetDisableMsgID | Indicate whether a receiving application requires message identifiers to be included in messages sent by the message producer. |
xmsMsgProducerSetDisableMsgTS | Indicate whether a receiving application requires time stamps to be included in messages sent by the message producer. |
xmsMsgProducerSetPriority | Set the default priority for messages sent by the message producer. |
xmsMsgProducerSetTimeToLive | Set the default length of time that a message exists before it expires. |
xmsRC xmsMsgProducerClose(xmsHMsgProducer *producer, xmsHErrorBlock errorBlock);
If an application tries to close a message producer that is already closed, the call is ignored.
xmsRC xmsMsgProducerGetDeliveryMode(xmsHMsgProducer producer, xmsINT *deliveryMode, xmsHErrorBlock errorBlock);
Get the default delivery mode for messages sent by the message producer.
For a real-time connection to a broker, the value is always XMSC_DELIVERY_NON_PERSISTENT.
xmsRC xmsMsgProducerGetDestination(xmsHMsgProducer producer, xmsHDest *destination, xmsHErrorBlock errorBlock);
Get the destination for the message producer.
xmsRC xmsMsgProducerGetDisableMsgID(xmsHMsgProducer producer, xmsBOOL *msgIDDisabled, xmsHErrorBlock errorBlock);
Get an indication of whether a receiving application requires message identifiers to be included in messages sent by the message producer.
xmsRC xmsMsgProducerGetDisableMsgTS(xmsHMsgProducer producer, xmsBOOL *timeStampDisabled, xmsHErrorBlock errorBlock);
Get an indication of whether a receiving application requires time stamps to be included in messages sent by the message producer.
xmsRC xmsMsgProducerGetPriority(xmsHMsgProducer producer, xmsINT *priority, xmsHErrorBlock errorBlock);
Get the default priority for messages sent by the message producer.
xmsRC xmsMsgProducerGetTimeToLive(xmsHMsgProducer producer, xmsLONG *timeToLive, xmsHErrorBlock errorBlock);
Get the default length of time that a message exists before it expires. The time is measured from when the message producer sends the message.
xmsRC xmsMsgProducerSend(xmsHMsgProducer producer, xmsHMsg message, xmsHErrorBlock errorBlock);
Send a message to the destination that was specified when the message producer was created. Send the message using the message producer's default delivery mode, priority, and time to live.
xmsRC xmsMsgProducerSendDest(xmsHMsgProducer producer, xmsHDest destination, xmsHMsg message, xmsHErrorBlock errorBlock);
Send a message to a specified destination if you are using a message producer for which no destination was specified when the message producer was created. Send the message using the message producer's default delivery mode, priority, and time to live.
Typically, you specify a destination when you create a message producer but, if you do not, you must specify a destination every time you send a message.
xmsRC xmsMsgProducerSendDestWithAttr(xmsHMsgProducer producer, xmsHDest destination, xmsHMsg message, xmsINT deliveryMode, xmsINT priority, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
Send a message to a specified destination if you are using a message producer for which no destination was specified when the message producer was created. Send the message using the specified delivery mode, priority, and time to live.
Typically, you specify a destination when you create a message producer but, if you do not, you must specify a destination every time you send a message.
For a real-time connection to a broker, the value must be XMSC_DELIVERY_NON_PERSISTENT.
xmsRC xmsMsgProducerSendWithAttr(xmsHMsgProducer producer, xmsHMsg message, xmsINT deliveryMode, xmsINT priority, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
Send a message to the destination that was specified when the message producer was created. Send the message using the specified delivery mode, priority, and time to live.
For a real-time connection to a broker, the value must be XMSC_DELIVERY_NON_PERSISTENT.
xmsRC xmsMsgProducerSetDeliveryMode(xmsHMsgProducer producer, xmsINT deliveryMode, xmsHErrorBlock errorBlock);
Set the default delivery mode for messages sent by the message producer.
For a real-time connection to a broker, the value must be XMSC_DELIVERY_NON_PERSISTENT.
The default value is XMSC_DELIVERY_PERSISTENT, except for a real-time connection to a broker for which the default value is XMSC_DELIVERY_NON_PERSISTENT.
xmsRC xmsMsgProducerSetDisableMsgID(xmsHMsgProducer producer, xmsBOOL msgIDDisabled, xmsHErrorBlock errorBlock);
Indicate whether a receiving application requires message identifiers to be included in messages sent by the message producer.
On a connection to a queue manager, or on a real-time connection to a broker, this flag is ignored. On a connection to a service integration bus, the flag is honoured.
xmsRC xmsMsgProducerSetDisableMsgTS(xmsHMsgProducer producer, xmsBOOL timeStampDisabled, xmsHErrorBlock errorBlock);
Indicate whether a receiving application requires time stamps to be included in messages sent by the message producer.
On a real-time connection to a broker, this flag is ignored. On a connection to a queue manager, or on a connection to a service integration bus, the flag is honoured.
xmsRC xmsMsgProducerSetPriority(xmsHMsgProducer producer, xmsINT priority, xmsHErrorBlock errorBlock);
Set the default priority for messages sent by the message producer.
On a real-time connection to a broker, the priority of a message is ignored.
xmsRC xmsMsgProducerSetTimeToLive(xmsHMsgProducer producer, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
Set the default length of time that a message exists before it expires. The time is measured from when the message producer sends the message.