tibemsQueueSender_Send


Function

Purpose

Send a message.

C Declaration

tibems_status tibemsQueueSender_Send( 
    tibemsQueueSender queueSender, 
    tibemsMsg message ); 
 
tibems_status tibemsQueueSender_SendEx( 
    tibemsQueueSender queueSender, 
    tibemsMsg message, 
    tibemsDeliveryMode deliveryMode, 
    tibems_int priority, 
    tibems_long timeToLive ); 
 
tibems_status tibemsQueueSender_SendToQueue( 
    tibemsQueueSender queueSender, 
    tibemsQueue queue, 
    tibemsMsg message ); 
 
tibems_status tibemsQueueSender_SendToQueueEx( 
    tibemsQueueSender queueSender, 
    tibemsQueue queue, 
    tibemsMsg message, 
    tibemsDeliveryMode deliveryMode, 
    tibems_int priority, 
    tibems_long timeToLive ); 

COBOL Call

CALL "tibemsQueueSender_Send" 
     USING BY VALUE queueSender, 
           BY VALUE message, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsQueueSender_SendEx" 
     USING BY VALUE queueSender, 
           BY VALUE message, 
           BY VALUE deliveryMode, 
           BY VALUE priority, 
           BY VALUE timeToLive, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsQueueSender_SendToQueue" 
     USING BY VALUE queueSender, 
           BY VALUE queue, 
           BY VALUE message, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsQueueSender_SendToQueueEx" 
     USING BY VALUE queueSender, 
           BY VALUE queue, 
           BY VALUE message, 
           BY VALUE deliveryMode, 
           BY VALUE priority, 
           BY VALUE timeToLive, 
           RETURNING tibems-status 
END-CALL. 

queueSender, message and queue have usage pointer.

Parameter
Description
queueSender
Send a message through this queue sender object.
queue
When present, the call sends the message to this queue.
Other send calls send the message to the sender’s default queue. When the sender object does not specify a default, the send call must supply this parameter.
message
Send this message object.
deliveryMode
When present, the call sends the message with this delivery mode.
This argument is an enumerated value (see tibemsDeliveryMode ).
Other send calls send the message with the sender’s default delivery mode.
priority
When present, the call sends the message with this priority.
Priority affects the order in which the server delivers messages to consumers (higher values first). The JMS specification defines ten levels of priority value, from zero (lowest priority) to 9 (highest priority). The specification suggests that clients consider 0–4 as gradations of normal priority, and priorities 5–9 as gradations of expedited priority.
Other send calls send the message with the sender’s default priority.
timeToLive
When present, the call uses this value (in milliseconds) to compute the message expiration.
  • If the time-to-live is non-zero, the expiration is the sum of that time-to-live and the sending client’s current time (GMT). This rule applies even within sessions with transaction semantics—the timer begins with the send call, not the commit call.
  • If the time-to-live is zero, then expiration is also zero—indicating that the message never expires.
Other send calls use the sender’s default value to compute expiration.
Whenever your application uses non-zero values for message expiration or time-to-live, you must ensure that clocks are synchronized among all the host computers that send and receive messages. Synchronize clocks to a tolerance that is a very small fraction of the smallest or time-to-live.

See Also

tibemsMsgProducer_Send


TIBCO Enterprise Message Service™ C and COBOL Reference
System Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com