bmqa::ConfirmEventBuilder Class Reference

#include <bmqa_confirmeventbuilder.h>

List of all members.

Public Member Functions
	ConfirmEventBuilder ()
	~ConfirmEventBuilder ()
bmqt::EventBuilderResult::Enum	addMessageConfirmation (const Message &message)
bmqt::EventBuilderResult::Enum	addMessageConfirmation (const MessageConfirmationCookie &cookie)
void	reset ()
int	messageCount () const
const bdlbb::Blob &	blob () const

---

Detailed Description

Mechanism to build a batch of CONFIRM messages.

See Component bmqa_confirmeventbuilder

---

Constructor & Destructor Documentation

bmqa::ConfirmEventBuilder::ConfirmEventBuilder

(

)

Create an invalid instance. Application should not create ConfirmEventBuilder themselves, but ask the bmqa::Session to give them one, by using bmqa::Session::loadConfirmEventBuilder.

bmqa::ConfirmEventBuilder::~ConfirmEventBuilder

(

)

Destroy this instance.

---

Member Function Documentation

bmqt::EventBuilderResult::Enum bmqa::ConfirmEventBuilder::addMessageConfirmation

(

const Message &

message

)

Append a confirmation message for the specified message. Return zero on success, and a non-zero value otherwise. Behavior is undefined unless this instance was obtained using bmqa::Session::loadConfirmEventBuilder.

bmqt::EventBuilderResult::Enum bmqa::ConfirmEventBuilder::addMessageConfirmation

(

const MessageConfirmationCookie &

cookie

)

Append a confirmation message for the specified MessageConfirmationCookie cookie. Return zero on success, and a non-zero value otherwise. Behavior is undefined unless this instance was obtained using bmqa::Session::loadConfirmEventBuilder.

void bmqa::ConfirmEventBuilder::reset

(

)

Reset the builder, effectively discarding the batch of confirmation messages under construction.

int bmqa::ConfirmEventBuilder::messageCount

(

)

const

Return the number of messages currently in the ConfirmEvent being built. Behavior is undefined unless this instance was obtained using bmqa::Session::loadConfirmEventBuilder.

const bdlbb::Blob& bmqa::ConfirmEventBuilder::blob

(

)

const

Return a reference not offering modifiable access to the blob of confirmation messages batch built by this builder. If no messages were added, this will return an empty blob, i.e., a blob with length == 0. Behavior is undefined unless this instance was obtained using bmqa::Session::loadConfirmEventBuilder.

---

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

• bmqa_confirmeventbuilder.h