#include <src/main/cms/MessageProducer.h>
MessageProducer
interface that is used by all MessageProducer derivations.
This class defines the JMS spec'd interface for a MessageProducer.
Public Member Functions | |
virtual | ~MessageProducer () |
virtual void | send (Message *message)=0 throw ( CMSException ) |
Sends the message to the default producer destination, but does not take ownership of the message, caller must still destroy it. | |
virtual void | send (Message *message, int deliveryMode, int priority, long long timeToLive)=0 throw ( CMSException ) |
Sends the message to the default producer destination, but does not take ownership of the message, caller must still destroy it. | |
virtual void | send (const Destination *destination, Message *message)=0 throw ( CMSException ) |
Sends the message to the designated destination, but does not take ownership of the message, caller must still destroy it. | |
virtual void | send (const Destination *destination, Message *message, int deliveryMode, int priority, long long timeToLive)=0 throw ( CMSException ) |
Sends the message to the designated destination, but does not take ownership of the message, caller must still destroy it. | |
virtual void | setDeliveryMode (int mode)=0 |
Sets the delivery mode for this Producer. | |
virtual int | getDeliveryMode () const =0 |
Gets the delivery mode for this Producer. | |
virtual void | setDisableMessageID (bool value)=0 |
Sets if Message Ids are disbled for this Producer. | |
virtual bool | getDisableMessageID () const =0 |
Gets if Message Ids are disbled for this Producer. | |
virtual void | setDisableMessageTimeStamp (bool value)=0 |
Sets if Message Time Stamps are disbled for this Producer. | |
virtual bool | getDisableMessageTimeStamp () const =0 |
Gets if Message Time Stamps are disbled for this Producer. | |
virtual void | setPriority (int priority)=0 |
Sets the Priority that this Producers sends messages at. | |
virtual int | getPriority () const =0 |
Gets the Priority level that this producer sends messages at. | |
virtual void | setTimeToLive (long long time)=0 |
Sets the Time to Live that this Producers sends messages with. | |
virtual long long | getTimeToLive () const =0 |
Gets the Time to Live that this producer sends messages with. |
virtual cms::MessageProducer::~MessageProducer | ( | ) | [inline, virtual] |
virtual void cms::MessageProducer::send | ( | Message * | message | ) | throw ( CMSException ) [pure virtual] |
Sends the message to the default producer destination, but does not take ownership of the message, caller must still destroy it.
Uses default values for deliveryMode, priority, and time to live.
message | - a Message Object Pointer |
CMSException |
virtual void cms::MessageProducer::send | ( | Message * | message, | |
int | deliveryMode, | |||
int | priority, | |||
long long | timeToLive | |||
) | throw ( CMSException ) [pure virtual] |
Sends the message to the default producer destination, but does not take ownership of the message, caller must still destroy it.
message | - a Message Object Pointer | |
deliverMode | The delivery mode to be used. | |
priority | The priority for this message. | |
timeToLive | The time to live value for this message in milliseconds. |
CMSException |
virtual void cms::MessageProducer::send | ( | const Destination * | destination, | |
Message * | message | |||
) | throw ( CMSException ) [pure virtual] |
Sends the message to the designated destination, but does not take ownership of the message, caller must still destroy it.
Uses default values for deliveryMode, priority, and time to live.
destination | - a Message Object Pointer | |
message | - the message to send to the destination |
CMSException |
virtual void cms::MessageProducer::send | ( | const Destination * | destination, | |
Message * | message, | |||
int | deliveryMode, | |||
int | priority, | |||
long long | timeToLive | |||
) | throw ( CMSException ) [pure virtual] |
Sends the message to the designated destination, but does not take ownership of the message, caller must still destroy it.
destination | - a Message Object Pointer | |
message | - a Message Object Pointer | |
deliverMode | The delivery mode to be used. | |
priority | The priority for this message. | |
timeToLive | The time to live value for this message in milliseconds. |
CMSException |
virtual void cms::MessageProducer::setDeliveryMode | ( | int | mode | ) | [pure virtual] |
virtual int cms::MessageProducer::getDeliveryMode | ( | ) | const [pure virtual] |
virtual void cms::MessageProducer::setDisableMessageID | ( | bool | value | ) | [pure virtual] |
Sets if Message Ids are disbled for this Producer.
value | - boolean indicating enable / disable (true / false) |
virtual bool cms::MessageProducer::getDisableMessageID | ( | ) | const [pure virtual] |
Gets if Message Ids are disbled for this Producer.
virtual void cms::MessageProducer::setDisableMessageTimeStamp | ( | bool | value | ) | [pure virtual] |
Sets if Message Time Stamps are disbled for this Producer.
value | - boolean indicating enable / disable (true / false) |
virtual bool cms::MessageProducer::getDisableMessageTimeStamp | ( | ) | const [pure virtual] |
Gets if Message Time Stamps are disbled for this Producer.
virtual void cms::MessageProducer::setPriority | ( | int | priority | ) | [pure virtual] |
Sets the Priority that this Producers sends messages at.
priority | - int value for Priority level |
virtual int cms::MessageProducer::getPriority | ( | ) | const [pure virtual] |
Gets the Priority level that this producer sends messages at.
virtual void cms::MessageProducer::setTimeToLive | ( | long long | time | ) | [pure virtual] |
Sets the Time to Live that this Producers sends messages with.
This value will be used if the time to live is not specified via the send method.
time | - default time to live value in milliseconds |
virtual long long cms::MessageProducer::getTimeToLive | ( | ) | const [pure virtual] |
Gets the Time to Live that this producer sends messages with.