bmqa::CloseQueueStatus Class Reference

#include <bmqa_closequeuestatus.h>

List of all members.

Public Member Functions
	CloseQueueStatus (bslma::Allocator *allocator=0)
	CloseQueueStatus (const bmqa::CloseQueueStatus &other, bslma::Allocator *allocator=0)
	CloseQueueStatus (const QueueId &queueId, bmqt::CloseQueueResult::Enum result, const bsl::string &errorDescription, bslma::Allocator *allocator=0)
CloseQueueStatus &	operator= (const CloseQueueStatus &rhs)
	operator bool () const
const QueueId &	queueId () const
bmqt::CloseQueueResult::Enum	result () const
const bsl::string &	errorDescription () const
bsl::ostream &	print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const

---

Detailed Description

A value-semantic type for a close queue operation with the message queue broker.

See Component bmqa_closequeuestatus

---

Constructor & Destructor Documentation

bmqa::CloseQueueStatus::CloseQueueStatus

(

bslma::Allocator *

allocator = 0

)

[explicit]

Default constructor, use the optionally specified allocator.

bmqa::CloseQueueStatus::CloseQueueStatus	(	const bmqa::CloseQueueStatus &	other,
		bslma::Allocator *	allocator = 0
	)

Create a new bmqa::CloseQueueStatus using the optionally specified allocator.

bmqa::CloseQueueStatus::CloseQueueStatus	(	const QueueId &	queueId,
		bmqt::CloseQueueResult::Enum	result,
		const bsl::string &	errorDescription,
		bslma::Allocator *	allocator = 0
	)

Create a new bmqa::CloseQueueStatus object having the specified queueId, result, and errorDescription, using the optionally specified allocator to supply memory.

---

Member Function Documentation

CloseQueueStatus& bmqa::CloseQueueStatus::operator=

(

const CloseQueueStatus &

rhs

)

Assign to this CloseQueueStatus the same values as the one from the specified rhs.

bmqa::CloseQueueStatus::operator bool

(

)

const

Return true if this result indicates success, and false otherwise.

const QueueId& bmqa::CloseQueueStatus::queueId

(

)

const

Return the queueId associated to this operation result, if any.

bmqt::CloseQueueResult::Enum bmqa::CloseQueueStatus::result

(

)

const

Return the status code that indicates success or the cause of a failure.

const bsl::string& bmqa::CloseQueueStatus::errorDescription

(

)

const

Return a printable description of the error, if result indicates failure. Return an empty string otherwise.

bsl::ostream& bmqa::CloseQueueStatus::print	(	bsl::ostream &	stream,
		int	level = 0,
		int	spacesPerLevel = 4
	)			const

Format this object to the specified output stream at the (absolute value of) the optionally specified indentation level and return a reference to stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect.

---

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

• bmqa_closequeuestatus.h