OpenMAMA C++ API
Wombat::MamaSendCompleteCallback Class Referenceabstract

Callback interface for use with the MamaPublisher.sendWithThrottle() and MamaPublisher.sendFromInboxWithThrottle() methods. More...

#include <MamaSendCompleteCallback.h>

Public Member Functions

virtual ~MamaSendCompleteCallback ()
 
virtual void onSendComplete (MamaPublisher &publisher, MamaMsg *msg, MamaStatus &status, void *closure)=0
 Called whenever the API has sent a message on the throttle queue. More...
 

Detailed Description

Callback interface for use with the MamaPublisher.sendWithThrottle() and MamaPublisher.sendFromInboxWithThrottle() methods.

The onSendComplete() method is invoked once a message being sent on the throttle is no longer required by the API.

Messages sent on the throttle queue are no longer destroyed by the API. It is the responsibility of the application developer to manage the lifecycle of any messages sent on the throttle.

Constructor & Destructor Documentation

§ ~MamaSendCompleteCallback()

virtual Wombat::MamaSendCompleteCallback::~MamaSendCompleteCallback ( )
inlinevirtual

Member Function Documentation

§ onSendComplete()

virtual void Wombat::MamaSendCompleteCallback::onSendComplete ( MamaPublisher publisher,
MamaMsg msg,
MamaStatus status,
void *  closure 
)
pure virtual

Called whenever the API has sent a message on the throttle queue.

Parameters
publisherThe publisher object used to send the message.
msgThe MamaMsg which has been sent from the throttle queue.
statusWhether the message was successfully sent from the throttle. A value of MAMA_STATUS_OK indicates that the send was successful.
closureUser supplied context data.