Wombat::MamaSendCompleteCallback

More…

#include <MamaSendCompleteCallback.h>

Public Functions

Detailed Description

class Wombat::MamaSendCompleteCallback;

Callback interface for use with the MamaPublisher.sendWithThrottle() and MamaPublisher.sendFromInboxWithThrottle() methods. The [onSendComplete()](classWombat_1_1MamaSendCompleteCallback.html#function-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.

Public Functions Documentation

function ~MamaSendCompleteCallback

inline virtual ~MamaSendCompleteCallback()

function onSendComplete

virtual void onSendComplete(
    MamaPublisher & publisher,
    MamaMsg * msg,
    MamaStatus & status,
    void * closure
) =0

Parameters:

• publisher The publisher object used to send the message.
• msg The MamaMsg which has been sent from the throttle queue.
• status Whether the message was successfully sent from the throttle. A value of MAMA_STATUS_OK indicates that the send was successful.
• closure User supplied context data.

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

Updated on 2023-03-31 at 15:29:25 +0100