bmqa_queueid.h

Go to the documentation of this file.

// Copyright 2014-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_queueid.h                                                     -*-C++-*-
#ifndef INCLUDED_BMQA_QUEUEID
#define INCLUDED_BMQA_QUEUEID
 
 
// BMQ
 
#include <bmqt_correlationid.h>
#include <bmqt_queueoptions.h>
#include <bmqt_uri.h>
 
// BDE
#include <bsl_iosfwd.h>
#include <bsl_memory.h>
#include <bsl_string.h>
#include <bslma_allocator.h>
#include <bslma_usesbslmaallocator.h>
#include <bslmf_nestedtraitdeclaration.h>
#include <bsls_types.h>
 
namespace BloombergLP {
 
// FORWARD DECLARATION
namespace bmqimp {
class Queue;
}
 
namespace bmqa {
 
// =============
// class QueueId
// =============
 
class QueueId {
    // FRIENDS
    friend bool operator==(const QueueId& lhs, const QueueId& rhs);
    friend bool operator!=(const QueueId& lhs, const QueueId& rhs);
    friend bool operator<(const QueueId& lhs, const QueueId& rhs);
 
  private:
    // DATA
    bsl::shared_ptr<bmqimp::Queue> d_impl_sp;  // pimpl
 
  public:
    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(QueueId, bslma::UsesBslmaAllocator)
 
    // CREATORS
 
    
    explicit QueueId(bslma::Allocator* allocator = 0);
 
    QueueId(const QueueId& other, bslma::Allocator* allocator = 0);
 
    explicit QueueId(const bmqt::CorrelationId& correlationId,
                     bslma::Allocator*          allocator = 0);
 
    explicit QueueId(bsls::Types::Int64 numeric,
                     bslma::Allocator*  allocator = 0);
 
    explicit QueueId(void* pointer, bslma::Allocator* allocator = 0);
 
    explicit QueueId(const bsl::shared_ptr<void>& sharedPtr,
                     bslma::Allocator*            allocator = 0);
 
    // MANIPULATORS
 
    QueueId& operator=(const QueueId& rhs);
 
    // ACCESSORS
 
    const bmqt::CorrelationId& correlationId() const;
 
    bsls::Types::Uint64 flags() const;
 
    const bmqt::Uri& uri() const;
 
    const bmqt::QueueOptions& options() const;
 
    bool isValid(bsl::ostream* reason_p = 0) const;
 
    bsl::ostream&
    print(bsl::ostream& stream, int level = 0, int spacesPerLevel = 4) const;
};
 
// FREE OPERATORS
 
bsl::ostream& operator<<(bsl::ostream& stream, const QueueId& rhs);
 
bool operator==(const QueueId& lhs, const QueueId& rhs);
 
bool operator!=(const QueueId& lhs, const QueueId& rhs);
 
bool operator<(const QueueId& lhs, const QueueId& rhs);
 
}  // close package namespace
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
// -------------
// class QueueId
// -------------
 
inline bsl::ostream& bmqa::operator<<(bsl::ostream&        stream,
                                      const bmqa::QueueId& rhs)
{
    return rhs.print(stream, 0, -1);
}
 
inline bool bmqa::operator==(const bmqa::QueueId& lhs,
                             const bmqa::QueueId& rhs)
{
    return rhs.d_impl_sp.get() == lhs.d_impl_sp.get();
}
 
inline bool bmqa::operator!=(const bmqa::QueueId& lhs,
                             const bmqa::QueueId& rhs)
{
    return rhs.d_impl_sp.get() != lhs.d_impl_sp.get();
}
 
inline bool bmqa::operator<(const bmqa::QueueId& lhs, const bmqa::QueueId& rhs)
{
    return rhs.d_impl_sp.get() < lhs.d_impl_sp.get();
}
 
}  // close enterprise namespace
 
#endif