cms::MessageProducer Class Reference

Inheritance diagram for cms::MessageProducer:

[legend]Collaboration diagram for cms::MessageProducer:

[legend]List of all members.

Public Member Functions
virtual	~MessageProducer ()
virtual void	send (Message *message)=0 throw ( CMSException )
virtual void	send (Message *message, int deliveryMode, int priority, long long timeToLive)=0 throw ( CMSException )
virtual void	send (const Destination *destination, Message *message)=0 throw ( CMSException )
virtual void	send (const Destination *destination, Message *message, int deliveryMode, int priority, long long timeToLive)=0 throw ( CMSException )
virtual void	setDeliveryMode (int mode)=0
virtual int	getDeliveryMode () const=0
virtual void	setDisableMessageID (bool value)=0
virtual bool	getDisableMessageID () const=0
virtual void	setDisableMessageTimeStamp (bool value)=0
virtual bool	getDisableMessageTimeStamp () const=0
virtual void	setPriority (int priority)=0
virtual int	getPriority () const=0
virtual void	setTimeToLive (long long time)=0
virtual long long	getTimeToLive () const=0

---

Detailed Description

defines the MessageProducer interface that is used by all MessageProducer derivations. This class defines the JMS spec'd interface for a MessageProducer.

---

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

---