cms::MessageProducer Class Reference

#include <src/main/cms/MessageProducer.h>

Inheritance diagram for cms::MessageProducer:

Inheritance graph
[legend]
Collaboration diagram for cms::MessageProducer:

Collaboration graph
[legend]

Detailed Description

defines the 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.


Constructor & Destructor Documentation

virtual cms::MessageProducer::~MessageProducer (  )  [inline, virtual]


Member Function Documentation

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.

Parameters:
message - a Message Object Pointer
Exceptions:
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.

Parameters:
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.
Exceptions:
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.

Parameters:
destination - a Message Object Pointer
message - the message to send to the destination
Exceptions:
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.

Parameters:
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.
Exceptions:
CMSException 

virtual void cms::MessageProducer::setDeliveryMode ( int  mode  )  [pure virtual]

Sets the delivery mode for this Producer.

Parameters:
mode - The DeliveryMode

virtual int cms::MessageProducer::getDeliveryMode (  )  const [pure virtual]

Gets the delivery mode for this Producer.

Returns:
The DeliveryMode

virtual void cms::MessageProducer::setDisableMessageID ( bool  value  )  [pure virtual]

Sets if Message Ids are disbled for this Producer.

Parameters:
value - boolean indicating enable / disable (true / false)

virtual bool cms::MessageProducer::getDisableMessageID (  )  const [pure virtual]

Gets if Message Ids are disbled for this Producer.

Returns:
boolean indicating enable / disable (true / false)

virtual void cms::MessageProducer::setDisableMessageTimeStamp ( bool  value  )  [pure virtual]

Sets if Message Time Stamps are disbled for this Producer.

Parameters:
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.

Returns:
boolean indicating enable / disable (true / false)

virtual void cms::MessageProducer::setPriority ( int  priority  )  [pure virtual]

Sets the Priority that this Producers sends messages at.

Parameters:
priority - int value for Priority level

virtual int cms::MessageProducer::getPriority (  )  const [pure virtual]

Gets the Priority level that this producer sends messages at.

Returns:
int based priority level

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.

Parameters:
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.

Returns:
Time to live value in milliseconds


The documentation for this class was generated from the following file:
Generated on Sat Oct 27 17:35:45 2007 for cms-1.1 by  doxygen 1.5.3