activemq::core::policies::DefaultRedeliveryPolicy Class Reference

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

Inheritance diagram for activemq::core::policies::DefaultRedeliveryPolicy:

Public Member Functions
	DefaultRedeliveryPolicy ()
virtual	~DefaultRedeliveryPolicy ()
virtual double	getBackOffMultiplier () const
virtual void	setBackOffMultiplier (double value)
	Sets the Back-Off Multiplier for Message Redelivery.
virtual short	getCollisionAvoidancePercent () const
virtual void	setCollisionAvoidancePercent (short value)
virtual long long	getInitialRedeliveryDelay () const
	Gets the initial time that redelivery of messages is delayed.
virtual void	setInitialRedeliveryDelay (long long value)
	Sets the initial time that redelivery will be delayed.
virtual long long	getRedeliveryDelay () const
	Gets the time that redelivery of messages is delayed.
virtual void	setRedeliveryDelay (long long value)
	Sets the time that redelivery will be delayed.
virtual int	getMaximumRedeliveries () const
	Gets the Maximum number of allowed redeliveries for a message before it will be discarded by the consumer.
virtual void	setMaximumRedeliveries (int value)
	Sets the Maximum allowable redeliveries for a Message.
virtual bool	isUseCollisionAvoidance () const
virtual void	setUseCollisionAvoidance (bool value)
virtual bool	isUseExponentialBackOff () const
virtual void	setUseExponentialBackOff (bool value)
virtual long long	getMaximumRedeliveryDelay () const
	Returns the maximum amount of time that the redelivery delay is allowed to increase to before it is capped.
virtual void	setMaximumRedeliveryDelay (long long value)
	Sets the maximum amount of time that the redelivery delay is allowed to increase to before it is capped.
virtual long long	getNextRedeliveryDelay (long long previousDelay)
	Given the last used redelivery delay calculate the next value of the delay based on the settings in this Policy instance.
virtual RedeliveryPolicy *	clone () const
	Create a copy of this Policy and return it.
Public Member Functions inherited from activemq::core::RedeliveryPolicy
virtual	~RedeliveryPolicy ()
virtual void	configure (const decaf::util::Properties &properties)
	Checks the supplied properties object for properties matching the configurable settings of this class.

Additional Inherited Members
Static Public Attributes inherited from activemq::core::RedeliveryPolicy
static const long long	NO_MAXIMUM_REDELIVERIES
Protected Member Functions inherited from activemq::core::RedeliveryPolicy
	RedeliveryPolicy ()

Constructor & Destructor Documentation

DefaultRedeliveryPolicy()

activemq::core::policies::DefaultRedeliveryPolicy::DefaultRedeliveryPolicy

(

)

~DefaultRedeliveryPolicy()

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

virtual

Member Function Documentation

clone()

virtual RedeliveryPolicy * activemq::core::policies::DefaultRedeliveryPolicy::clone ( ) const

virtual

Create a copy of this Policy and return it.

Returns

pointer to a new RedeliveryPolicy that is a copy of this one.

Implements activemq::core::RedeliveryPolicy.

getBackOffMultiplier()

virtual double activemq::core::policies::DefaultRedeliveryPolicy::getBackOffMultiplier ( ) const

inlinevirtual

Returns

The value of the Back-Off Multiplier for Message Redelivery.

Implements activemq::core::RedeliveryPolicy.

getCollisionAvoidancePercent()

virtual short activemq::core::policies::DefaultRedeliveryPolicy::getCollisionAvoidancePercent ( ) const

virtual

Returns

the currently set Collision Avoidance percentage.

Implements activemq::core::RedeliveryPolicy.

getInitialRedeliveryDelay()

virtual long long activemq::core::policies::DefaultRedeliveryPolicy::getInitialRedeliveryDelay ( ) const

inlinevirtual

Gets the initial time that redelivery of messages is delayed.

Returns

the time in milliseconds that redelivery is delayed initially.

Implements activemq::core::RedeliveryPolicy.

getMaximumRedeliveries()

virtual int activemq::core::policies::DefaultRedeliveryPolicy::getMaximumRedeliveries ( ) const

inlinevirtual

Gets the Maximum number of allowed redeliveries for a message before it will be discarded by the consumer.

Returns

maximum allowed redeliveries for a message.

Implements activemq::core::RedeliveryPolicy.

getMaximumRedeliveryDelay()

virtual long long activemq::core::policies::DefaultRedeliveryPolicy::getMaximumRedeliveryDelay ( ) const

inlinevirtual

Returns the maximum amount of time that the redelivery delay is allowed to increase to before it is capped.

Returns

the maximum redelivery delay value.

Implements activemq::core::RedeliveryPolicy.

getNextRedeliveryDelay()

virtual long long activemq::core::policies::DefaultRedeliveryPolicy::getNextRedeliveryDelay ( long long previousDelay )

virtual

Given the last used redelivery delay calculate the next value of the delay based on the settings in this Policy instance.

Parameters

previousDelay

The last delay that was used between message redeliveries.

Returns

the new delay to use before attempting another redelivery.

Implements activemq::core::RedeliveryPolicy.

getRedeliveryDelay()

virtual long long activemq::core::policies::DefaultRedeliveryPolicy::getRedeliveryDelay ( ) const

inlinevirtual

Gets the time that redelivery of messages is delayed.

Returns

the time in milliseconds that redelivery is delayed.

Implements activemq::core::RedeliveryPolicy.

isUseCollisionAvoidance()

virtual bool activemq::core::policies::DefaultRedeliveryPolicy::isUseCollisionAvoidance ( ) const

inlinevirtual

Returns

whether or not collision avoidance is enabled for this Policy.

Implements activemq::core::RedeliveryPolicy.

isUseExponentialBackOff()

virtual bool activemq::core::policies::DefaultRedeliveryPolicy::isUseExponentialBackOff ( ) const

inlinevirtual

Returns

whether or not the exponential back off option is enabled.

Implements activemq::core::RedeliveryPolicy.

setBackOffMultiplier()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setBackOffMultiplier ( double value )

inlinevirtual

Sets the Back-Off Multiplier for Message Redelivery.

Parameters

value

The new value for the back-off multiplier.

Implements activemq::core::RedeliveryPolicy.

setCollisionAvoidancePercent()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setCollisionAvoidancePercent ( short value )

virtual

Parameters

value

The collision avoidance percentage setting.

Implements activemq::core::RedeliveryPolicy.

setInitialRedeliveryDelay()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setInitialRedeliveryDelay ( long long value )

inlinevirtual

Sets the initial time that redelivery will be delayed.

Parameters

value

Time in Milliseconds to wait before starting redelivery.

Implements activemq::core::RedeliveryPolicy.

setMaximumRedeliveries()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setMaximumRedeliveries ( int maximumRedeliveries )

inlinevirtual

Sets the Maximum allowable redeliveries for a Message.

Parameters

maximumRedeliveries

The maximum number of times that a message will be redelivered.

Implements activemq::core::RedeliveryPolicy.

setMaximumRedeliveryDelay()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setMaximumRedeliveryDelay ( long long value )

inlinevirtual

Sets the maximum amount of time that the redelivery delay is allowed to increase to before it is capped.

By default this value is set to -1 which disables any maximum delay.

Parameters

value

The maximum redelivery delay value in milliseconds.

Implements activemq::core::RedeliveryPolicy.

setRedeliveryDelay()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setRedeliveryDelay ( long long value )

inlinevirtual

Sets the time that redelivery will be delayed.

Parameters

value

Time in Milliseconds to wait before the next redelivery.

Implements activemq::core::RedeliveryPolicy.

setUseCollisionAvoidance()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setUseCollisionAvoidance ( bool value )

inlinevirtual

Parameters

value

Enable or Disable collision avoidance for this Policy.

Implements activemq::core::RedeliveryPolicy.

setUseExponentialBackOff()

virtual void activemq::core::policies::DefaultRedeliveryPolicy::setUseExponentialBackOff ( bool value )

inlinevirtual

Parameters

value

Enable or Disable the exponential back off multiplier option.

Implements activemq::core::RedeliveryPolicy.

---

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

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