// Copyright 2019-2023 Bloomberg Finance L.P.
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// bmqa_closequeuestatus.h -*-C++-*-
#ifndef INCLUDED_BMQA_CLOSEQUEUESTATUS
#define INCLUDED_BMQA_CLOSEQUEUESTATUS
//@PURPOSE: Provide Value-Semantic Type for a close queue operation status
//
//@CLASSES:
// bmqa::CloseQueueStatus: value-semantic type for a closeQueue result
//
//@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:
//: o !result!: indicates the status of the operation (success,
//: failure, etc.) as specified in the corresponding
//: result code enum, 'bmqt::CloseQueueResult::Enum'
//: o !queueId!: queueId associated with the close queue operation
//: o !errorDescription!: optional string with a human readable description of
//: the error, if any
// BMQ
#include <bmqscm_version.h>
#include <bmqa_queueid.h>
#include <bmqt_resultcode.h>
// BDE
#include <bsl_iostream.h>
#include <bsl_string.h>
#include <bslma_allocator.h>
#include <bslma_default.h>
#include <bslma_usesbslmaallocator.h>
#include <bslmf_nestedtraitdeclaration.h>
namespace BloombergLP {
namespace bmqa {
// ======================
// class CloseQueueStatus
// ======================
class CloseQueueStatus {
// A value-semantic type for a close queue operation with the message queue
// broker.
private:
// DATA
QueueId d_queueId;
// queueId associated with the open
// queue operation
bmqt::CloseQueueResult::Enum d_result;
// Result code of the operation
// (success, failure)
bsl::string d_errorDescription;
// Optional string with a human
// readable description of the error,
// if any
public:
// TRAITS
BSLMF_NESTED_TRAIT_DECLARATION(CloseQueueStatus, bslma::UsesBslmaAllocator)
// CREATORS
explicit CloseQueueStatus(bslma::Allocator *allocator = 0);
// Default constructor, use the optionally specified 'allocator'.
CloseQueueStatus(const bmqa::CloseQueueStatus& other,
bslma::Allocator *allocator = 0);
// Create a new 'bmqa::CloseQueueStatus' using the optionally specified
// 'allocator'.
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.
// MANIPULATORS
CloseQueueStatus& operator=(const CloseQueueStatus& rhs);
// Assign to this 'CloseQueueStatus' the same values as the one from the
// specified 'rhs'.
// ACCESSORS
operator bool() const;
// Return true if this result indicates success, and false otherwise.
const QueueId& queueId() const;
// Return the queueId associated to this operation result, if any.
bmqt::CloseQueueResult::Enum result() const;
// Return the status code that indicates success or the cause of a
// failure.
const bsl::string& errorDescription() const;
// Return a printable description of the error, if 'result'
// indicates failure. Return an empty string otherwise.
bsl::ostream& 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.
};
// FREE OPERATORS
bool operator==(const CloseQueueStatus& lhs, const CloseQueueStatus& rhs);
// Return 'true' if the specified 'rhs' object contains the value of the
// same type as contained in the specified 'lhs' object and the value
// itself is the same in both objects, return false otherwise.
bool operator!=(const CloseQueueStatus& lhs, const CloseQueueStatus& rhs);
// Return 'false' if the specified 'rhs' object contains the value of the
// same type as contained in the specified 'lhs' object and the value
// itself is the same in both objects, return 'true' otherwise.
bsl::ostream& operator<<(bsl::ostream& stream, const CloseQueueStatus& rhs);
// Format the specified 'rhs' to the specified output 'stream' and return a
// reference to the modifiable 'stream'.
// ============================================================================
// INLINE DEFINITIONS
// ============================================================================
// ----------------------
// class CloseQueueStatus
// ----------------------
// CREATORS
inline
CloseQueueStatus::CloseQueueStatus(bslma::Allocator *allocator)
: d_queueId(allocator)
, d_result(bmqt::CloseQueueResult::e_SUCCESS)
, d_errorDescription(allocator)
{
// NOTHING
}
inline
CloseQueueStatus::CloseQueueStatus(const CloseQueueStatus& other,
bslma::Allocator *allocator)
: d_queueId(other.d_queueId, allocator)
, d_result(other.d_result)
, d_errorDescription(other.d_errorDescription)
{
// NOTHING
}
inline
CloseQueueStatus::CloseQueueStatus(
const QueueId& queueId,
bmqt::CloseQueueResult::Enum result,
const bsl::string& errorDescription,
bslma::Allocator *allocator)
: d_queueId(queueId, allocator)
, d_result(result)
, d_errorDescription(errorDescription)
{
// NOTHING
}
// MANIPULATORS
inline
CloseQueueStatus&
CloseQueueStatus::operator=(const CloseQueueStatus& other)
{
d_queueId = other.queueId();
d_result = other.result();
d_errorDescription = other.errorDescription();
return *this;
}
// ACCESSORS
inline
CloseQueueStatus::operator bool() const
{
return d_result == bmqt::CloseQueueResult::e_SUCCESS;
}
inline
const QueueId&
CloseQueueStatus::queueId() const
{
return d_queueId;
}
inline
bmqt::CloseQueueResult::Enum
CloseQueueStatus::result() const
{
return d_result;
}
inline
const bsl::string&
CloseQueueStatus::errorDescription() const
{
return d_errorDescription;
}
} // close package namespace
// FREE OPERATORS
inline
bsl::ostream&
bmqa::operator<<(bsl::ostream& stream,
const bmqa::CloseQueueStatus& rhs)
{
return rhs.print(stream, 0, -1);
}
inline
bool
bmqa::operator==(const bmqa::CloseQueueStatus& lhs,
const bmqa::CloseQueueStatus& rhs)
{
return lhs.queueId() == rhs.queueId()
&& lhs.result() == rhs.result()
&& lhs.errorDescription() == rhs.errorDescription();
}
inline
bool
bmqa::operator!=(const bmqa::CloseQueueStatus& lhs,
const bmqa::CloseQueueStatus& rhs)
{
return !(lhs == rhs);
}
} // close enterprise namespace
#endif