Interface for a Policy object that controls message Prefetching on various destination types in ActiveMQ-CPP.
More...
#include <src/main/activemq/core/PrefetchPolicy.h>
|
virtual | ~PrefetchPolicy () |
|
virtual void | setDurableTopicPrefetch (int value)=0 |
| Sets the amount of prefetched messages for a Durable Topic.
|
|
virtual int | getDurableTopicPrefetch () const =0 |
| Gets the amount of messages to prefetch for a Durable Topic.
|
|
virtual void | setQueuePrefetch (int value)=0 |
| Sets the amount of prefetched messages for a Queue.
|
|
virtual int | getQueuePrefetch () const =0 |
| Gets the amount of messages to prefetch for a Queue.
|
|
virtual void | setQueueBrowserPrefetch (int value)=0 |
| Sets the amount of prefetched messages for a Queue Browser.
|
|
virtual int | getQueueBrowserPrefetch () const =0 |
| Gets the amount of messages to prefetch for a Queue Browser.
|
|
virtual void | setTopicPrefetch (int value)=0 |
| Sets the amount of prefetched messages for a Topic.
|
|
virtual int | getTopicPrefetch () const =0 |
| Gets the amount of messages to prefetch for a Topic.
|
|
virtual void | setAll (int value) |
| Sets the prefetch value on all available prefetch configuration options.
|
|
virtual int | getMaxPrefetchLimit (int value) const =0 |
| 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 =0 |
| Clone the Policy and return a new pointer to that clone.
|
|
virtual void | configure (const decaf::util::Properties &properties) |
| Checks the supplied properties object for properties matching the configurable settings of this class.
|
|
Interface for a Policy object that controls message Prefetching on various destination types in ActiveMQ-CPP.
- Since
- 3.2.0
◆ PrefetchPolicy()
activemq::core::PrefetchPolicy::PrefetchPolicy |
( |
| ) |
|
|
protected |
◆ ~PrefetchPolicy()
virtual activemq::core::PrefetchPolicy::~PrefetchPolicy |
( |
| ) |
|
|
virtual |
◆ clone()
virtual PrefetchPolicy * activemq::core::PrefetchPolicy::clone |
( |
| ) |
const |
|
pure virtual |
◆ configure()
Checks the supplied properties object for properties matching the configurable settings of this class.
The default implementation looks for properties named with the prefix cms.PrefetchPolicy.XXX where XXX is the name of a property with a public setter method. For instance cms.PrefetchPolicy.topicPrefetch will be used to set the value of the topic prefetch limit.
Subclasses can override this method to add more configuration options or to exclude certain parameters from being set via the properties object.
- Parameters
-
properties | The Properties object used to configure this object. |
- Exceptions
-
NumberFormatException | if a property that is numeric cannot be converted |
IllegalArgumentException | if a property can't be converted to the correct type. |
◆ getDurableTopicPrefetch()
virtual int activemq::core::PrefetchPolicy::getDurableTopicPrefetch |
( |
| ) |
const |
|
pure virtual |
◆ getMaxPrefetchLimit()
virtual int activemq::core::PrefetchPolicy::getMaxPrefetchLimit |
( |
int | value | ) |
const |
|
pure 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.
Implemented in activemq::core::policies::DefaultPrefetchPolicy.
◆ getQueueBrowserPrefetch()
virtual int activemq::core::PrefetchPolicy::getQueueBrowserPrefetch |
( |
| ) |
const |
|
pure virtual |
◆ getQueuePrefetch()
virtual int activemq::core::PrefetchPolicy::getQueuePrefetch |
( |
| ) |
const |
|
pure virtual |
◆ getTopicPrefetch()
virtual int activemq::core::PrefetchPolicy::getTopicPrefetch |
( |
| ) |
const |
|
pure virtual |
◆ setAll()
virtual void activemq::core::PrefetchPolicy::setAll |
( |
int | value | ) |
|
|
virtual |
Sets the prefetch value on all available prefetch configuration options.
- Parameters
-
value | the prefetch value to set on all prefetch options. |
◆ setDurableTopicPrefetch()
virtual void activemq::core::PrefetchPolicy::setDurableTopicPrefetch |
( |
int | value | ) |
|
|
pure virtual |
◆ setQueueBrowserPrefetch()
virtual void activemq::core::PrefetchPolicy::setQueueBrowserPrefetch |
( |
int | value | ) |
|
|
pure virtual |
◆ setQueuePrefetch()
virtual void activemq::core::PrefetchPolicy::setQueuePrefetch |
( |
int | value | ) |
|
|
pure virtual |
◆ setTopicPrefetch()
virtual void activemq::core::PrefetchPolicy::setTopicPrefetch |
( |
int | value | ) |
|
|
pure virtual |
The documentation for this class was generated from the following file: