javax::jms::ServerSessionPool Class Reference

A ServerSessionPool object is an object implemented by an application server to provide a pool of ServerSession objects for processing the messages of a ConnectionConsumer (optional). More...

#include <javax_jms_ServerSessionPool.h>

Inheritance diagram for javax::jms::ServerSessionPool:

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

[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::ServerSessionPool >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::ServerSessionPool > >	array2D
Public Member Functions
virtual ::javax::jms::ServerSession	getServerSession (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Return a server session from the pool.

---

Detailed Description

A ServerSessionPool object is an object implemented by an application server to provide a pool of ServerSession objects for processing the messages of a ConnectionConsumer (optional).

Its only method is getServerSession. The JMS API does not architect how the pool is implemented. It could be a static pool of ServerSession objects, or it could use a sophisticated algorithm to dynamically create ServerSession objects as needed.

If the ServerSessionPool is out of ServerSession objects, the getServerSession call may block. If a ConnectionConsumer is blocked, it cannot deliver new messages until a ServerSession is eventually returned.

Author:

Mark Hapner

Rich Burridge

---

Member Function Documentation

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

Return a server session from the pool. 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: a server session from the pool

---

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

• javax_jms_ServerSessionPool.h

---