TIBCO EMS .NET API 10.2
TIBCO EMS .NET API 10.2
|
A client uses a QueueSender object to send messages to a queue. More...
Public Member Functions | |
override void | Send (Message message) |
Sends a message to the queue. Uses the QueueSender's default delivery mode, priority, and time to live. More... | |
override void | Send (Message message, int deliveryMode, int priority, long timeToLive) |
Sends a message to the queue, specifying delivery mode, priority, and time to live. More... | |
override void | Send (Message message, MessageDeliveryMode deliveryMode, int priority, long timeToLive) |
Sends a message to the queue, specifying delivery mode, priority, and time to live. More... | |
void | Send (TIBCO.EMS.Queue queue, Message message) |
Sends a message to a queue for an unidentified queue sender. Uses the QueueSender's default delivery mode, priority, and time to live. More... | |
void | Send (TIBCO.EMS.Queue queue, Message message, int deliveryMode, int priority, long timeToLive) |
Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default delivery mode, priority, and time to live. More... | |
void | Send (TIBCO.EMS.Queue queue, Message message, MessageDeliveryMode deliveryMode, int priority, long timeToLive) |
Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default delivery mode, priority, and time to live. More... | |
Properties | |
TIBCO.EMS.Queue | Queue [get] |
Gets the queue associated with this QueueSender. More... | |
A client uses a QueueSender object to send messages to a queue.
This class extends MessageProducer. It overloads more send methods, specializing the destination parameter to a queue.
Normally, the Queue is specified when a QueueSender is created. In this case, an attempt to use the send methods for an unidentified QueueSender will throw a UnsupportedOperationException.
If the QueueSender is created with an unidentified Queue, an attempt to use the send methods that assume that the Queue has been identified will throw a UnsupportedOperationException.
During the execution of its send method, a message must not be changed by other threads within the client. If the message is modified, the result of the send is undefined.
After sending a message, a client may retain and modify it without affecting the message that has been sent. The same message object may be sent multiple times.
The following message headers are set as part of sending a message: Destination, DeliveryMode, Expiration, Priority, MessageID and TimeStamp. When the message is sent, the values of these headers are ignored. After the completion of the send, the headers hold the values specified by the method sending the message. It is possible for the send method to not set the MessageID and TimeStamp if they are explicitly disabled by setting the MessageProducer.DisableMessageID or MessageProducer.DisableMessageTimestamp property.
Note: This class is provided for backward compatibility to support older EMS clients programs. New clients should use the MessageProducer class instead.
|
inlinevirtual |
Sends a message to the queue. Uses the QueueSender's default delivery mode, priority, and time to live.
message | The message to send. |
Reimplemented from TIBCO.EMS.MessageProducer.
|
inlinevirtual |
Sends a message to the queue, specifying delivery mode, priority, and time to live.
message | The message to send. |
deliveryMode | The delivery mode to use. This argument may be either an enumerated value (see MessageDeliveryMode) or an integer (see DeliveryMode). We recommend enumerated values, because they enable .NET to do stronger type checking at compile time, which can enhance program reliability. |
priority | The priority for this message. Priority affects the order in which the server delivers messages to consumers (higher values first). The Jakarta Messaging 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. |
timeToLive | The message's lifetime (in milliseconds) before it expires.
|
Programs can use this property to define a default time-to-live for messages that this producer sends. Individual sending calls can override this default value.
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.
Reimplemented from TIBCO.EMS.MessageProducer.
|
inlinevirtual |
Sends a message to the queue, specifying delivery mode, priority, and time to live.
message | The message to send. |
deliveryMode | The delivery mode to use. This argument may be either an enumerated value (see MessageDeliveryMode) or an integer (see DeliveryMode). We recommend enumerated values, because they enable .NET to do stronger type checking at compile time, which can enhance program reliability. |
priority | The priority for this message. Priority affects the order in which the server delivers messages to consumers (higher values first). The Jakarta Messaging 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. |
timeToLive | The message's lifetime (in milliseconds) before it expires.
|
Programs can use this property to define a default time-to-live for messages that this producer sends. Individual sending calls can override this default value.
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.
Reimplemented from TIBCO.EMS.MessageProducer.
|
inline |
Sends a message to a queue for an unidentified queue sender. Uses the QueueSender's default delivery mode, priority, and time to live.
Typically, a message producer is assigned a queue at creation time; however, the TIBCO EMS .NET API also supports unidentified message producers, which require that the queue be supplied every time a message is sent.
queue | the queue to send this message to |
message | The message to send. |
|
inline |
Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default delivery mode, priority, and time to live.
Typically, a message producer is assigned a queue at creation time; however, the TIBCO EMS .NET API also supports unidentified message producers, which require that the queue be supplied every time a message is sent.
queue | the queue to send this message to |
message | The message to send. |
deliveryMode | The delivery mode to use. This argument may be either an enumerated value (see MessageDeliveryMode) or an integer (see DeliveryMode). We recommend enumerated values, because they enable .NET to do stronger type checking at compile time, which can enhance program reliability. |
priority | The priority for this message. Priority affects the order in which the server delivers messages to consumers (higher values first). The Jakarta Messaging 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. |
timeToLive | The message's lifetime (in milliseconds) before it expires.
|
Programs can use this property to define a default time-to-live for messages that this producer sends. Individual sending calls can override this default value.
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.
|
inline |
Sends a message to a queue for an unidentified message producer. Uses the QueueSender's default delivery mode, priority, and time to live.
Typically, a message producer is assigned a queue at creation time; however, the TIBCO EMS .NET API also supports unidentified message producers, which require that the queue be supplied every time a message is sent.
queue | the queue to send this message to |
message | The message to send. |
deliveryMode | The delivery mode to use. This argument may be either an enumerated value (see MessageDeliveryMode) or an integer (see DeliveryMode). We recommend enumerated values, because they enable .NET to do stronger type checking at compile time, which can enhance program reliability. |
priority | The priority for this message. Priority affects the order in which the server delivers messages to consumers (higher values first). The Jakarta Messaging 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. |
timeToLive | The message's lifetime (in milliseconds) before it expires.
|
Programs can use this property to define a default time-to-live for messages that this producer sends. Individual sending calls can override this default value.
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.
|
get |
Gets the queue associated with this QueueSender.
Each send call directs a message to a queue.
A client can use this property to define a default queue for messages that this producer sends. Individual sending calls can override this default value.
A client sets this queue when creating the sender, and cannot subsequently change it.