bmqt_queueflags.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.
 
// bmqt_queueflags.h                                                  -*-C++-*-
#ifndef INCLUDED_BMQT_QUEUEFLAGS
#define INCLUDED_BMQT_QUEUEFLAGS
 
 
// BMQ
 
// BDE
#include <bsl_iosfwd.h>
#include <bsl_string.h>
#include <bsls_types.h>
 
namespace BloombergLP {
namespace bmqt {
 
// =================
// struct QueueFlags
// =================
 
struct QueueFlags {
    // TYPES
    enum Enum {
        e_ADMIN = (1 << 0)  // The queue is opened in admin mode (Valid only
                            // for BlazingMQ admin tasks)
        ,
        e_READ = (1 << 1)  // The queue is opened for consuming messages
        ,
        e_WRITE = (1 << 2)  // The queue is opened for posting messages
        ,
        e_ACK = (1 << 3)  // Set to indicate interested in receiving
                          // 'ACK' events for all message posted
    };
 
    // PUBLIC CONSTANTS
 
    static const int k_LOWEST_SUPPORTED_QUEUE_FLAG = e_ADMIN;
 
    static const int k_HIGHEST_SUPPORTED_QUEUE_FLAG = e_ACK;
 
    // CLASS METHODS
 
    static bsl::ostream& print(bsl::ostream&    stream,
                               QueueFlags::Enum value,
                               int              level          = 0,
                               int              spacesPerLevel = 4);
 
    static const char* toAscii(QueueFlags::Enum value);
 
    static bool fromAscii(QueueFlags::Enum* out, const bslstl::StringRef& str);
};
 
// FREE OPERATORS
 
bsl::ostream& operator<<(bsl::ostream& stream, QueueFlags::Enum value);
 
// =====================
// struct QueueFlagsUtil
// =====================
 
struct QueueFlagsUtil {
  public:
    // CLASS METHODS
 
    static bool isSet(bsls::Types::Uint64 flags, QueueFlags::Enum flag);
 
  public:
    // CLASS METHODS
 
    static bool isValid(bsl::ostream&       errorDescription,
                        bsls::Types::Uint64 flags);
 
    static bsls::Types::Uint64 empty();
 
    static bool isEmpty(bsls::Types::Uint64 flags);
 
    static bool isReader(bsls::Types::Uint64 flags);
 
    static bool isWriter(bsls::Types::Uint64 flags);
 
    static bool isAdmin(bsls::Types::Uint64 flags);
 
    static bool isAck(bsls::Types::Uint64 flags);
 
    static void setReader(bsls::Types::Uint64* flags);
 
    static void setAdmin(bsls::Types::Uint64* flags);
 
    static void setWriter(bsls::Types::Uint64* flags);
 
    static void setAck(bsls::Types::Uint64* flags);
 
    static void unsetReader(bsls::Types::Uint64* flags);
 
    static void unsetAdmin(bsls::Types::Uint64* flags);
 
    static void unsetWriter(bsls::Types::Uint64* flags);
 
    static void unsetAck(bsls::Types::Uint64* flags);
 
    static bsls::Types::Uint64 additions(bsls::Types::Uint64 oldFlags,
                                         bsls::Types::Uint64 newFlags);
 
    static bsls::Types::Uint64 removals(bsls::Types::Uint64 oldFlags,
                                        bsls::Types::Uint64 newFlags);
 
    static bsl::ostream& prettyPrint(bsl::ostream&       stream,
                                     bsls::Types::Uint64 flags);
 
    static int fromString(bsl::ostream&        errorDescription,
                          bsls::Types::Uint64* out,
                          const bsl::string&   str);
};
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
// ---------------------
// struct QueueFlagsUtil
// ---------------------
 
inline bool QueueFlagsUtil::isSet(bsls::Types::Uint64 flags,
                                  QueueFlags::Enum    flag)
{
    return ((flags & flag) != 0);
}
 
inline void QueueFlagsUtil::setReader(bsls::Types::Uint64* flags)
{
    *flags |= bmqt::QueueFlags::e_READ;
}
 
inline void QueueFlagsUtil::setAdmin(bsls::Types::Uint64* flags)
{
    *flags |= bmqt::QueueFlags::e_ADMIN;
}
 
inline void QueueFlagsUtil::setWriter(bsls::Types::Uint64* flags)
{
    *flags |= bmqt::QueueFlags::e_WRITE;
}
 
inline void QueueFlagsUtil::setAck(bsls::Types::Uint64* flags)
{
    *flags |= bmqt::QueueFlags::e_ACK;
}
 
inline void QueueFlagsUtil::unsetReader(bsls::Types::Uint64* flags)
{
    *flags &= ~bmqt::QueueFlags::e_READ;
}
 
inline void QueueFlagsUtil::unsetAdmin(bsls::Types::Uint64* flags)
{
    *flags &= ~bmqt::QueueFlags::e_ADMIN;
}
 
inline void QueueFlagsUtil::unsetWriter(bsls::Types::Uint64* flags)
{
    *flags &= ~bmqt::QueueFlags::e_WRITE;
}
 
inline void QueueFlagsUtil::unsetAck(bsls::Types::Uint64* flags)
{
    *flags &= ~bmqt::QueueFlags::e_ACK;
}
 
inline bool QueueFlagsUtil::isReader(bsls::Types::Uint64 flags)
{
    return isSet(flags, bmqt::QueueFlags::e_READ);
}
 
inline bool QueueFlagsUtil::isWriter(bsls::Types::Uint64 flags)
{
    return isSet(flags, bmqt::QueueFlags::e_WRITE);
}
 
inline bool QueueFlagsUtil::isAdmin(bsls::Types::Uint64 flags)
{
    return isSet(flags, bmqt::QueueFlags::e_ADMIN);
}
 
inline bool QueueFlagsUtil::isAck(bsls::Types::Uint64 flags)
{
    return isSet(flags, bmqt::QueueFlags::e_ACK);
}
 
inline bool QueueFlagsUtil::isEmpty(bsls::Types::Uint64 flags)
{
    return flags == empty();
}
 
inline bsls::Types::Uint64 QueueFlagsUtil::empty()
{
    return 0;
}
 
}  // close package namespace
 
// -----------------
// struct QueueFlags
// -----------------
 
inline bsl::ostream& bmqt::operator<<(bsl::ostream&          stream,
                                      bmqt::QueueFlags::Enum value)
{
    return bmqt::QueueFlags::print(stream, value, 0, -1);
}
 
}  // close enterprise namespace
 
#endif