bmqa_closequeuestatus.h

Go to the documentation of this file.

// 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
 
 
// BMQ
 
#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>
#include <bsls_unspecifiedbool.h>
 
namespace BloombergLP {
namespace bmqa {
 
// ======================
// class CloseQueueStatus
// ======================
 
class CloseQueueStatus {
  private:
    // DATA
 
    QueueId d_queueId;
 
    bmqt::CloseQueueResult::Enum d_result;
 
    bsl::string d_errorDescription;
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(CloseQueueStatus, bslma::UsesBslmaAllocator)
 
    // TYPES
 
    // Use of an `UnspecifiedBool` to prevent implicit conversions to
    // integral values, and comparisons between different classes which
    // have boolean operators.
    typedef bsls::UnspecifiedBool<CloseQueueStatus>::BoolType BoolType;
 
    // CREATORS
 
    explicit 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);
 
    // MANIPULATORS
 
    CloseQueueStatus& operator=(const CloseQueueStatus& rhs);
 
    // ACCESSORS
 
    operator BoolType() 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;
};
 
// FREE OPERATORS
 
bool operator==(const CloseQueueStatus& lhs, const CloseQueueStatus& rhs);
 
bool operator!=(const CloseQueueStatus& lhs, const CloseQueueStatus& rhs);
 
bsl::ostream& operator<<(bsl::ostream& stream, const CloseQueueStatus& rhs);
 
// ============================================================================
//                             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 BoolType() const
{
    return bsls::UnspecifiedBool<CloseQueueStatus>::makeValue(
        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