#include <src/main/activemq/core/kernels/ActiveMQSessionKernel.h>

Inheritance diagram for activemq::core::kernels::ActiveMQSessionKernel:

Public Member Functions
	ActiveMQSessionKernel (ActiveMQConnection *connection, const Pointer< commands::SessionId > &id, cms::Session::AcknowledgeMode ackMode, const decaf::util::Properties &properties)
virtual	~ActiveMQSessionKernel ()
virtual void	redispatch (MessageDispatchChannel &unconsumedMessages)
	Redispatches the given set of unconsumed messages to the consumers.
virtual void	start ()
	Stops asynchronous message delivery.
virtual void	stop ()
	Starts asynchronous message delivery.
bool	isStarted () const
	Indicates whether or not the session is currently in the started state.
virtual bool	isAutoAcknowledge () const
virtual bool	isDupsOkAcknowledge () const
virtual bool	isClientAcknowledge () const
virtual bool	isIndividualAcknowledge () const
void	fire (const exceptions::ActiveMQException &ex)
	Fires the given exception to the exception listener of the connection.
virtual void	dispatch (const Pointer< MessageDispatch > &message)
	Dispatches a message to a particular consumer.
virtual void	close ()
	Closes this session as well as any active child consumers or producers.
virtual void	commit ()
	Commits all messages done in this transaction and releases any locks currently held.
virtual void	rollback ()
	Rolls back all messages done in this transaction and releases any locks currently held.
virtual void	recover ()
	Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.
virtual cms::MessageConsumer *	createConsumer (const cms::Destination *destination)
	Creates a MessageConsumer for the specified destination.
virtual cms::MessageConsumer *	createConsumer (const cms::Destination *destination, const std::string &selector)
	Creates a MessageConsumer for the specified destination, using a message selector.
virtual cms::MessageConsumer *	createConsumer (const cms::Destination *destination, const std::string &selector, bool noLocal)
	Creates a MessageConsumer for the specified destination, using a message selector.
virtual cms::MessageConsumer *	createDurableConsumer (const cms::Topic *destination, const std::string &name, const std::string &selector, bool noLocal=false)
	Creates a durable subscriber to the specified topic, using a Message selector.
virtual cms::MessageProducer *	createProducer (const cms::Destination *destination)
	Creates a MessageProducer to send messages to the specified destination.
virtual cms::QueueBrowser *	createBrowser (const cms::Queue *queue)
	Creates a new QueueBrowser to peek at Messages on the given Queue.
virtual cms::QueueBrowser *	createBrowser (const cms::Queue *queue, const std::string &selector)
	Creates a new QueueBrowser to peek at Messages on the given Queue.
virtual cms::Queue *	createQueue (const std::string &queueName)
	Creates a queue identity given a Queue name.
virtual cms::Topic *	createTopic (const std::string &topicName)
	Creates a topic identity given a Queue name.
virtual cms::TemporaryQueue *	createTemporaryQueue ()
	Creates a TemporaryQueue object.
virtual cms::TemporaryTopic *	createTemporaryTopic ()
	Creates a TemporaryTopic object.
virtual cms::Message *	createMessage ()
	Creates a new Message.
virtual cms::BytesMessage *	createBytesMessage ()
	Creates a BytesMessage.
virtual cms::BytesMessage *	createBytesMessage (const unsigned char *bytes, int bytesSize)
	Creates a BytesMessage and sets the payload to the passed value.
virtual cms::StreamMessage *	createStreamMessage ()
	Creates a new StreamMessage.
virtual cms::TextMessage *	createTextMessage ()
	Creates a new TextMessage.
virtual cms::TextMessage *	createTextMessage (const std::string &text)
	Creates a new TextMessage and set the text to the value given.
virtual cms::MapMessage *	createMapMessage ()
	Creates a new MapMessage.
virtual cms::Session::AcknowledgeMode	getAcknowledgeMode () const
	Returns the acknowledgment mode of the session.
virtual bool	isTransacted () const
	Gets if the Sessions is a Transacted Session.
virtual void	unsubscribe (const std::string &name)
	Unsubscribes a durable subscription that has been created by a client.
void	send (kernels::ActiveMQProducerKernel producer, Pointer< commands::ActiveMQDestination > destination, cms::Message message, int deliveryMode, int priority, long long timeToLive, util::MemoryUsage producerWindow, long long sendTimeout, cms::AsyncCallback onComplete)
	Sends a message from the Producer specified using this session's connection the message will be sent using the best available means depending on the configuration of the connection.
cms::ExceptionListener *	getExceptionListener ()
	This method gets any registered exception listener of this sessions connection and returns it.
virtual void	setMessageTransformer (cms::MessageTransformer *transformer)
	Set an MessageTransformer instance that is passed on to all MessageProducer and MessageConsumer objects created from this Session.
virtual cms::MessageTransformer *	getMessageTransformer () const
	Gets the currently configured MessageTransformer for this Session.
const commands::SessionInfo &	getSessionInfo () const
	Gets the Session Information object for this session, if the session is closed than this method throws an exception.
const commands::SessionId &	getSessionId () const
	Gets the Session Id object for this session, if the session is closed than this method throws an exception.
ActiveMQConnection *	getConnection () const
	Gets the ActiveMQConnection that is associated with this session.
Pointer< threads::Scheduler >	getScheduler () const
	Gets a Pointer to this Session's Scheduler instance.
long long	getLastDeliveredSequenceId () const
	Gets the currently set Last Delivered Sequence Id.
void	setLastDeliveredSequenceId (long long value)
	Sets the value of the Last Delivered Sequence Id.
void	oneway (Pointer< commands::Command > command)
	Sends a Command to the broker without requesting any Response be returned.
Pointer< commands::Response >	syncRequest (Pointer< commands::Command > command, unsigned int timeout=0)
	Sends a synchronous request and returns the response from the broker.
void	addConsumer (Pointer< ActiveMQConsumerKernel > consumer)
	Adds a MessageConsumerKernel to this session registering it with the Connection and store a reference to it so the session can ensure that all resources are closed when the session is closed.
void	removeConsumer (Pointer< ActiveMQConsumerKernel > consumer)
	Dispose of a MessageConsumer from this session.
void	addProducer (Pointer< ActiveMQProducerKernel > producer)
	Adds a MessageProducer to this session registering it with the Connection and store a reference to it so the session can ensure that all resources are closed when the session is closed.
void	removeProducer (Pointer< ActiveMQProducerKernel > producer)
	Dispose of a MessageProducer from this session.
virtual void	doStartTransaction ()
	Starts if not already start a Transaction for this Session.
Pointer < ActiveMQTransactionContext >	getTransactionContext ()
	Gets the Pointer to this Session's TransactionContext.
void	acknowledge ()
	Request that the Session inform all its consumers to Acknowledge all Message's that have been received so far.
void	deliverAcks ()
	Request that this Session inform all of its consumers to deliver their pending acks.
void	clearMessagesInProgress ()
	Request that this Session inform all of its consumers to clear all messages that are currently in progress.
void	wakeup ()
	Causes the Session to wakeup its executer and ensure all messages are dispatched.
Pointer< commands::ConsumerId >	getNextConsumerId ()
	Get the Next available Consumer Id.
Pointer< commands::ProducerId >	getNextProducerId ()
	Get the Next available Producer Id.
void	doClose ()
	Performs the actual Session close operations.
void	dispose ()
	Cleans up the Session object's resources without attempting to send the Remove command to the broker, this can be called from ActiveMQConnection when it knows that the transport is down and the doClose method would throw an exception when it attempt to send the Remove Command.
void	setPrefetchSize (Pointer< commands::ConsumerId > id, int prefetch)
	Set the prefetch level for the given consumer if it exists in this Session to the value specified.
void	close (Pointer< commands::ConsumerId > id)
	Close the specified consumer if present in this Session.
bool	isInUse (Pointer< commands::ActiveMQDestination > destination)
	Checks if the given destination is currently in use by any consumers in this Session.
Pointer< ActiveMQProducerKernel >	lookupProducerKernel (Pointer< commands::ProducerId > id)
Pointer< ActiveMQConsumerKernel >	lookupConsumerKernel (Pointer< commands::ConsumerId > id)
bool	iterateConsumers ()
	Gives each consumer a chance to dispatch messages that have been enqueued by calling each consumers iterate method.
Public Member Functions inherited from cms::Session
virtual	~Session ()
Public Member Functions inherited from cms::Closeable
virtual	~Closeable ()
Public Member Functions inherited from cms::Startable
virtual	~Startable ()
Public Member Functions inherited from cms::Stoppable
virtual	~Stoppable ()
Public Member Functions inherited from activemq::core::Dispatcher
virtual	~Dispatcher ()

Protected Attributes
SessionConfig *	config
Pointer< commands::SessionInfo >	sessionInfo
	SessionInfo for this Session.
Pointer < ActiveMQTransactionContext >	transaction
	Transaction Management object.
ActiveMQConnection *	connection
	Connection.
AtomicBoolean	closed
	Indicates that this connection has been closed, it is no longer usable after this becomes true.
std::auto_ptr < ActiveMQSessionExecutor >	executor
	Sends incoming messages to the registered consumers.
cms::Session::AcknowledgeMode	ackMode
	This Sessions Acknowledgment mode.
util::LongSequenceGenerator	producerIds
	Next available Producer Id.
util::LongSequenceGenerator	producerSequenceIds
	Next available Producer Sequence Id.
util::LongSequenceGenerator	consumerIds
	Next available Consumer Id.
long long	lastDeliveredSequenceId
	Last Delivered Sequence Id.

Friends
class	activemq::core::ActiveMQSessionExecutor

Additional Inherited Members
Public Types inherited from cms::Session
enum	AcknowledgeMode { AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, SESSION_TRANSACTED, INDIVIDUAL_ACKNOWLEDGE }

Constructor & Destructor Documentation

activemq::core::kernels::ActiveMQSessionKernel::ActiveMQSessionKernel	(	ActiveMQConnection *	connection,
		const Pointer< commands::SessionId > &	id,
		cms::Session::AcknowledgeMode	ackMode,
		const decaf::util::Properties &	properties
	)

virtual activemq::core::kernels::ActiveMQSessionKernel::~ActiveMQSessionKernel ( )

virtual

Member Function Documentation

void activemq::core::kernels::ActiveMQSessionKernel::acknowledge ( )

Request that the Session inform all its consumers to Acknowledge all Message's that have been received so far.

void activemq::core::kernels::ActiveMQSessionKernel::addConsumer ( Pointer< ActiveMQConsumerKernel > consumer )

Adds a MessageConsumerKernel to this session registering it with the Connection and store a reference to it so the session can ensure that all resources are closed when the session is closed.

Parameters

consumer The ActiveMQConsumerKernel instance to add to this session.

Exceptions

ActiveMQException if an internal error occurs.

void activemq::core::kernels::ActiveMQSessionKernel::addProducer ( Pointer< ActiveMQProducerKernel > producer )

Adds a MessageProducer to this session registering it with the Connection and store a reference to it so the session can ensure that all resources are closed when the session is closed.

Parameters

producer The ActiveMQProducerKernel instance to add to this session.

Exceptions

ActiveMQException if an internal error occurs.

void activemq::core::kernels::ActiveMQSessionKernel::clearMessagesInProgress ( )

Request that this Session inform all of its consumers to clear all messages that are currently in progress.

virtual void activemq::core::kernels::ActiveMQSessionKernel::close ( )

virtual

Closes this session as well as any active child consumers or producers.

Exceptions

CMSException - If an internal error occurs.

CMSException	- If an internal error occurs.
IllegalStateException	- if the method is not called by a transacted session.

CMSException	- If an internal error occurs.
InvalidDestinationException	- if the destination given is invalid.

queue	the Queue to browse
selector	the Message selector to filter which messages are browsed.

bytes	an array of bytes to set in the message
bytesSize	the size of the bytes array, or number of bytes to use

destination	the Destination that this consumer receiving messages for.
selector	the Message Selector to use

destination	the topic to subscribe to
name	The name used to identify the subscription
selector	the Message Selector to use
noLocal	if true, and the destination is a topic, inhibits the delivery of messages published by its own connection. The behavior for NoLocal is not specified if the destination is a queue.

CMSException	- if the CMS provider fails to stop and restart message delivery due to some internal error.
IllegalStateException	- if the method is called by a transacted session.

void activemq::core::kernels::ActiveMQSessionKernel::send	(	kernels::ActiveMQProducerKernel *	producer,
		Pointer< commands::ActiveMQDestination >	destination,
		cms::Message *	message,
		int	deliveryMode,
		int	priority,
		long long	timeToLive,
		util::MemoryUsage *	producerWindow,
		long long	sendTimeout,
		cms::AsyncCallback *	onComplete
	)

producer	The sending Producer
destination	The target destination for the Message.
message	The message to send to the broker.
deliveryMode	The delivery mode to assign to the outgoing message.
priority	The priority value to assign to the outgoing message.
timeToLive	The time to live for the outgoing message.
usage	Pointer to a Usage tracker which if set will be increased by the size of the given message.
sendTimeout	The amount of time to block during send before failing, or 0 to wait forever.

void activemq::core::kernels::ActiveMQSessionKernel::setPrefetchSize	(	Pointer< commands::ConsumerId >	id,
		int	prefetch
	)

id	The consumer Id to search for and set prefetch level.
prefetch	The new prefetch value.

Pointer<commands::Response> activemq::core::kernels::ActiveMQSessionKernel::syncRequest	(	Pointer< commands::Command >	command,
		unsigned int	timeout = `0`
	)

command	The command to send to the broker.
timeout	The time to wait for a response, default is zero or infinite.

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation