activemq::core::policies::DefaultPrefetchPolicy Class Reference

#include <src/main/activemq/core/policies/DefaultPrefetchPolicy.h>

Inheritance diagram for activemq::core::policies::DefaultPrefetchPolicy:

[legend]

Public Member Functions
	DefaultPrefetchPolicy ()
virtual	~DefaultPrefetchPolicy ()
virtual void	setDurableTopicPrefetch (int value)
	Sets the amount of prefetched messages for a Durable Topic.
virtual int	getDurableTopicPrefetch () const
	Gets the amount of messages to prefetch for a Durable Topic.
virtual void	setQueuePrefetch (int value)
	Sets the amount of prefetched messages for a Queue.
virtual int	getQueuePrefetch () const
	Gets the amount of messages to prefetch for a Queue.
virtual void	setQueueBrowserPrefetch (int value)
	Sets the amount of prefetched messages for a Queue Browser.
virtual int	getQueueBrowserPrefetch () const
	Gets the amount of messages to prefetch for a Queue Browser.
virtual void	setTopicPrefetch (int value)
	Sets the amount of prefetched messages for a Topic.
virtual int	getTopicPrefetch () const
	Gets the amount of messages to prefetch for a Topic.
virtual int	getMaxPrefetchLimit (int value) const
	Given a requested value for a new prefetch limit, compare it against some max prefetch value and return either the requested value or the maximum allowable value for prefetch.
virtual PrefetchPolicy *	clone () const
	Clone the Policy and return a new pointer to that clone.
Static Public Attributes
static int	MAX_PREFETCH_SIZE
static int	DEFAULT_DURABLE_TOPIC_PREFETCH
static int	DEFAULT_QUEUE_PREFETCH
static int	DEFAULT_QUEUE_BROWSER_PREFETCH
static int	DEFAULT_TOPIC_PREFETCH

---

Constructor & Destructor Documentation

activemq::core::policies::DefaultPrefetchPolicy::DefaultPrefetchPolicy

(

)

virtual activemq::core::policies::DefaultPrefetchPolicy::~DefaultPrefetchPolicy

(

)

[virtual]

---

Member Function Documentation

virtual PrefetchPolicy* activemq::core::policies::DefaultPrefetchPolicy::clone

(

)

const [virtual]

Clone the Policy and return a new pointer to that clone.

Returns:

pointer to a new PrefetchPolicy instance that is a clone of this one.

Implements activemq::core::PrefetchPolicy.

virtual int activemq::core::policies::DefaultPrefetchPolicy::getDurableTopicPrefetch

(

)

const [inline, virtual]

Gets the amount of messages to prefetch for a Durable Topic.

Returns:

value of the number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual int activemq::core::policies::DefaultPrefetchPolicy::getMaxPrefetchLimit

(

int

value

)

const [inline, virtual]

Given a requested value for a new prefetch limit, compare it against some max prefetch value and return either the requested value or the maximum allowable value for prefetch.

Returns:

the allowable value for a prefetch limit, either requested or the max.

Implements activemq::core::PrefetchPolicy.

virtual int activemq::core::policies::DefaultPrefetchPolicy::getQueueBrowserPrefetch

(

)

const [inline, virtual]

Gets the amount of messages to prefetch for a Queue Browser.

Returns:

value of the number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual int activemq::core::policies::DefaultPrefetchPolicy::getQueuePrefetch

(

)

const [inline, virtual]

Gets the amount of messages to prefetch for a Queue.

Returns:

value of the number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual int activemq::core::policies::DefaultPrefetchPolicy::getTopicPrefetch

(

)

const [inline, virtual]

Gets the amount of messages to prefetch for a Topic.

Returns:

value of the number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setDurableTopicPrefetch

(

int

value

)

[inline, virtual]

Sets the amount of prefetched messages for a Durable Topic.

Parameters:

value

The number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setQueueBrowserPrefetch

(

int

value

)

[inline, virtual]

Sets the amount of prefetched messages for a Queue Browser.

Parameters:

value

The number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setQueuePrefetch

(

int

value

)

[inline, virtual]

Sets the amount of prefetched messages for a Queue.

Parameters:

value

The number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setTopicPrefetch

(

int

value

)

[inline, virtual]

Sets the amount of prefetched messages for a Topic.

Parameters:

value

The number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

---

Field Documentation

int activemq::core::policies::DefaultPrefetchPolicy::DEFAULT_DURABLE_TOPIC_PREFETCH [static]

int activemq::core::policies::DefaultPrefetchPolicy::DEFAULT_QUEUE_BROWSER_PREFETCH [static]

int activemq::core::policies::DefaultPrefetchPolicy::DEFAULT_QUEUE_PREFETCH [static]

int activemq::core::policies::DefaultPrefetchPolicy::DEFAULT_TOPIC_PREFETCH [static]

int activemq::core::policies::DefaultPrefetchPolicy::MAX_PREFETCH_SIZE [static]

---

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

• src/main/activemq/core/policies/DefaultPrefetchPolicy.h