OpenMAMA C++ API
Wombat::MamaQueueMonitorCallback Class Referenceabstract

Receive callbacks when certain conditions for the MamaQueue are met. More...

#include <MamaQueueMonitorCallback.h>

Public Member Functions

virtual ~MamaQueueMonitorCallback ()
 
virtual void onHighWatermarkExceeded (MamaQueue *queue, size_t size, void *closure)=0
 Callback invoked if an upper size limit has been specified for a queue and that limit has been exceeded. More...
 
virtual void onLowWatermark (MamaQueue *queue, size_t size, void *closure)=0
 Callback when low water mark is reached. More...
 

Detailed Description

Receive callbacks when certain conditions for the MamaQueue are met.

Currently only one callback is defined which is invoked when the specified size limit on the MamaQueue is exceeded.

Constructor & Destructor Documentation

§ ~MamaQueueMonitorCallback()

virtual Wombat::MamaQueueMonitorCallback::~MamaQueueMonitorCallback ( )
inlinevirtual

Member Function Documentation

§ onHighWatermarkExceeded()

virtual void Wombat::MamaQueueMonitorCallback::onHighWatermarkExceeded ( MamaQueue queue,
size_t  size,
void *  closure 
)
pure virtual

Callback invoked if an upper size limit has been specified for a queue and that limit has been exceeded.

Parameters
queuePointer to the queue for which this callback was invoked.
sizeThe number of events on the queue if supported; otherwise 0.
closureUser supplied data when the callback object was registered.

§ onLowWatermark()

virtual void Wombat::MamaQueueMonitorCallback::onLowWatermark ( MamaQueue queue,
size_t  size,
void *  closure 
)
pure virtual

Callback when low water mark is reached.

Only supported by Wombat TCP middleware.

Parameters
queuePointer to the queue for which this callback was invoked.
sizeThe number of events on the queue.
closureUser supplied data when the callback object was registered.