activemq-cpp-3.9.5
activemq::core::ActiveMQMessageAudit Class Reference

#include <src/main/activemq/core/ActiveMQMessageAudit.h>

Public Member Functions

 ActiveMQMessageAudit ()
 Default Constructor windowSize = 2048, maximumNumberOfProducersToTrack = 64.
 
 ActiveMQMessageAudit (int auditDepth, int maximumNumberOfProducersToTrack)
 Construct a MessageAudit.
 
 ~ActiveMQMessageAudit ()
 
int getAuditDepth () const
 Gets the currently configured Audit Depth.
 
void setAuditDepth (int value)
 Sets a new Audit Depth value.
 
int getMaximumNumberOfProducersToTrack () const
 
void getMaximumNumberOfProducersToTrack (int value)
 Sets the number of producers to track.
 
bool isDuplicate (const std::string &msgId) const
 checks whether this messageId has been seen before and adds this messageId to the list
 
bool isDuplicate (decaf::lang::Pointer< commands::MessageId > msgId) const
 Checks if this messageId has been seen before.
 
void rollback (const std::string &msgId)
 Marks this message as being received.
 
void rollback (decaf::lang::Pointer< commands::MessageId > msgId)
 Marks this message as being received.
 
bool isInOrder (const std::string &msgId) const
 Check the MessageId is in order.
 
bool isInOrder (decaf::lang::Pointer< commands::MessageId > msgId) const
 Check the MessageId is in order.
 
long long getLastSeqId (decaf::lang::Pointer< commands::ProducerId > id) const
 
void clear ()
 Clears this Audit.
 

Static Public Attributes

static const int DEFAULT_WINDOW_SIZE
 
static const int MAXIMUM_PRODUCER_COUNT
 

Constructor & Destructor Documentation

◆ ActiveMQMessageAudit() [1/2]

activemq::core::ActiveMQMessageAudit::ActiveMQMessageAudit ( )

Default Constructor windowSize = 2048, maximumNumberOfProducersToTrack = 64.

◆ ActiveMQMessageAudit() [2/2]

activemq::core::ActiveMQMessageAudit::ActiveMQMessageAudit ( int auditDepth,
int maximumNumberOfProducersToTrack )

Construct a MessageAudit.

Parameters
auditDepthThe range of ids to track.
maximumNumberOfProducersToTrackThe number of producers expected in the system

◆ ~ActiveMQMessageAudit()

activemq::core::ActiveMQMessageAudit::~ActiveMQMessageAudit ( )

Member Function Documentation

◆ clear()

void activemq::core::ActiveMQMessageAudit::clear ( )

Clears this Audit.

◆ getAuditDepth()

int activemq::core::ActiveMQMessageAudit::getAuditDepth ( ) const

Gets the currently configured Audit Depth.

Returns
the current audit depth setting

◆ getLastSeqId()

long long activemq::core::ActiveMQMessageAudit::getLastSeqId ( decaf::lang::Pointer< commands::ProducerId > id) const
Returns
the last sequence Id that we've audited for the given producer.

◆ getMaximumNumberOfProducersToTrack() [1/2]

int activemq::core::ActiveMQMessageAudit::getMaximumNumberOfProducersToTrack ( ) const
Returns
the current number of producers that will be tracked.

◆ getMaximumNumberOfProducersToTrack() [2/2]

void activemq::core::ActiveMQMessageAudit::getMaximumNumberOfProducersToTrack ( int value)

Sets the number of producers to track.

Parameters
valueThe number of producers expected in the system

◆ isDuplicate() [1/2]

bool activemq::core::ActiveMQMessageAudit::isDuplicate ( const std::string & msgId) const

checks whether this messageId has been seen before and adds this messageId to the list

Parameters
msgIdThe string value Message Id.
Returns
true if the message is a duplicate.

◆ isDuplicate() [2/2]

bool activemq::core::ActiveMQMessageAudit::isDuplicate ( decaf::lang::Pointer< commands::MessageId > msgId) const

Checks if this messageId has been seen before.

Parameters
msgIdThe target MessageId to check.
Returns
true if the message is a duplicate

◆ isInOrder() [1/2]

bool activemq::core::ActiveMQMessageAudit::isInOrder ( const std::string & msgId) const

Check the MessageId is in order.

Parameters
msgIdThe string value Message Id.
Returns
true if the MessageId is in order.

◆ isInOrder() [2/2]

bool activemq::core::ActiveMQMessageAudit::isInOrder ( decaf::lang::Pointer< commands::MessageId > msgId) const

Check the MessageId is in order.

Parameters
msgIdThe target MessageId to check.
Returns
true if the MessageId is in order.

◆ rollback() [1/2]

void activemq::core::ActiveMQMessageAudit::rollback ( const std::string & msgId)

Marks this message as being received.

Parameters
msgIdThe string value Message Id.

◆ rollback() [2/2]

void activemq::core::ActiveMQMessageAudit::rollback ( decaf::lang::Pointer< commands::MessageId > msgId)

Marks this message as being received.

Parameters
msgIdThe target MessageId to check.

◆ setAuditDepth()

void activemq::core::ActiveMQMessageAudit::setAuditDepth ( int value)

Sets a new Audit Depth value.

Parameters
valueThe range of ids to track.

Field Documentation

◆ DEFAULT_WINDOW_SIZE

const int activemq::core::ActiveMQMessageAudit::DEFAULT_WINDOW_SIZE
static

◆ MAXIMUM_PRODUCER_COUNT

const int activemq::core::ActiveMQMessageAudit::MAXIMUM_PRODUCER_COUNT
static

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