javax::jms::ConnectionConsumer Class Reference

For application servers, Connection objects provide a special facility for creating a ConnectionConsumer (optional). More...

#include <javax_jms_ConnectionConsumer.h>

Inheritance diagram for javax::jms::ConnectionConsumer:

[legend]Collaboration diagram for javax::jms::ConnectionConsumer:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::ConnectionConsumer >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::ConnectionConsumer > >	array2D
Public Member Functions
virtual void	close (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Closes the connection consumer.
virtual ::javax::jms::ServerSessionPool	getServerSessionPool (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the server session pool associated with this connection consumer.

---

Detailed Description

For application servers, Connection objects provide a special facility for creating a ConnectionConsumer (optional).

The messages it is to consume are specified by a Destination and a message selector. In addition, a ConnectionConsumer must be given a ServerSessionPool to use for processing its messages.

Normally, when traffic is light, a ConnectionConsumer gets a ServerSession from its pool, loads it with a single message, and starts it. As traffic picks up, messages can back up. If this happens, a ConnectionConsumer can load each ServerSession with more than one message. This reduces the thread context switches and minimizes resource use at the expense of some serialization of message processing.

Author:

Mark Hapner

Rich Burridge

---

Member Function Documentation

virtual void javax::jms::ConnectionConsumer::close (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Closes the connection consumer. Since a provider may allocate some resources on behalf of a connection consumer outside the Java virtual machine, clients should close these resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::javax::jms::ServerSessionPool javax::jms::ConnectionConsumer::getServerSessionPool (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the server session pool associated with this connection consumer. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the server session pool used by this connection consumer

---

The documentation for this class was generated from the following file:

• javax_jms_ConnectionConsumer.h

---