bmqa_closequeuestatus.h File Reference

Provide Value-Semantic Type for a close queue operation status. More...

#include <bmqa_queueid.h>
#include <bmqt_resultcode.h>
#include <bsl_iostream.h>
#include <bsl_string.h>
#include <bslma_allocator.h>
#include <bslma_default.h>
#include <bslma_usesbslmaallocator.h>
#include <bslmf_nestedtraitdeclaration.h>
#include <bsls_unspecifiedbool.h>

Go to the source code of this file.

Classes
class	BloombergLP::bmqa::CloseQueueStatus

Namespaces
	BloombergLP
	BloombergLP::bmqa

Functions
bool	BloombergLP::bmqa::operator== (const CloseQueueStatus &lhs, const CloseQueueStatus &rhs)
bool	BloombergLP::bmqa::operator!= (const CloseQueueStatus &lhs, const CloseQueueStatus &rhs)
bsl::ostream &	BloombergLP::bmqa::operator<< (bsl::ostream &stream, const CloseQueueStatus &rhs)

Detailed Description

This component provides a specific value-semantic type for the result of a close queue operation with the BlazingMQ broker, providing applications with the result and context of the requested operation.

A bmqa::CloseQueueStatus type is composed of 3 attributes:

1. result: indicates the status of the operation (success, failure, etc.) as specified in the corresponding result code enum, bmqt::CloseQueueResult::Enum.
2. queueId: queueId associated with the close queue operation.
3. errorDescription: optional string with a human readable description of the error, if any.