activemq-cpp-3.9.5
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.
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.
Public Member Functions inherited from activemq::core::PrefetchPolicy
virtual ~PrefetchPolicy ()
virtual void setAll (int value)
 Sets the prefetch value on all available prefetch configuration options.
virtual void configure (const decaf::util::Properties &properties)
 Checks the supplied properties object for properties matching the configurable settings of this class.

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

◆ DefaultPrefetchPolicy()

activemq::core::policies::DefaultPrefetchPolicy::DefaultPrefetchPolicy ( )

◆ ~DefaultPrefetchPolicy()

virtual activemq::core::policies::DefaultPrefetchPolicy::~DefaultPrefetchPolicy ( )
virtual

Member Function Documentation

◆ clone()

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.

◆ getDurableTopicPrefetch()

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.

◆ getMaxPrefetchLimit()

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.

References MAX_PREFETCH_SIZE.

Referenced by setDurableTopicPrefetch(), setQueueBrowserPrefetch(), setQueuePrefetch(), and setTopicPrefetch().

◆ getQueueBrowserPrefetch()

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.

◆ getQueuePrefetch()

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.

◆ getTopicPrefetch()

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.

◆ setDurableTopicPrefetch()

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.

References getMaxPrefetchLimit().

◆ setQueueBrowserPrefetch()

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.

References getMaxPrefetchLimit().

◆ setQueuePrefetch()

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.

References getMaxPrefetchLimit().

◆ setTopicPrefetch()

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.

References getMaxPrefetchLimit().

Field Documentation

◆ DEFAULT_DURABLE_TOPIC_PREFETCH

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

◆ DEFAULT_QUEUE_BROWSER_PREFETCH

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

◆ DEFAULT_QUEUE_PREFETCH

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

◆ DEFAULT_TOPIC_PREFETCH

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

◆ MAX_PREFETCH_SIZE

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

Referenced by getMaxPrefetchLimit().


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