activemq-cpp-3.8.2
activemq::core::policies::DefaultPrefetchPolicy Class Reference

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

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

Public Member Functions

 DefaultPrefetchPolicy ()
 
virtual ~DefaultPrefetchPolicy ()
 
virtual void setDurableTopicPrefetch (int value)
 Sets the amount of prefetched messages for a Durable Topic. More...
 
virtual int getDurableTopicPrefetch () const
 Gets the amount of messages to prefetch for a Durable Topic. More...
 
virtual void setQueuePrefetch (int value)
 Sets the amount of prefetched messages for a Queue. More...
 
virtual int getQueuePrefetch () const
 Gets the amount of messages to prefetch for a Queue. More...
 
virtual void setQueueBrowserPrefetch (int value)
 Sets the amount of prefetched messages for a Queue Browser. More...
 
virtual int getQueueBrowserPrefetch () const
 Gets the amount of messages to prefetch for a Queue Browser. More...
 
virtual void setTopicPrefetch (int value)
 Sets the amount of prefetched messages for a Topic. More...
 
virtual int getTopicPrefetch () const
 Gets the amount of messages to prefetch for a Topic. More...
 
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. More...
 
virtual PrefetchPolicy * clone () const
 Clone the Policy and return a new pointer to that clone. More...
 
- Public Member Functions inherited from activemq::core::PrefetchPolicy
virtual ~PrefetchPolicy ()
 
virtual void configure (const decaf::util::Properties &properties)
 Checks the supplied properties object for properties matching the configurable settings of this class. More...
 

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
 

Additional Inherited Members

- Protected Member Functions inherited from activemq::core::PrefetchPolicy
 PrefetchPolicy ()
 

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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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)
inlinevirtual

Sets the amount of prefetched messages for a Durable Topic.

Parameters
valueThe number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setQueueBrowserPrefetch ( int  value)
inlinevirtual

Sets the amount of prefetched messages for a Queue Browser.

Parameters
valueThe number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setQueuePrefetch ( int  value)
inlinevirtual

Sets the amount of prefetched messages for a Queue.

Parameters
valueThe number of messages to prefetch.

Implements activemq::core::PrefetchPolicy.

virtual void activemq::core::policies::DefaultPrefetchPolicy::setTopicPrefetch ( int  value)
inlinevirtual

Sets the amount of prefetched messages for a Topic.

Parameters
valueThe 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: