libbmq ecc88f70b521c69eeac96cc22d896b0acda2f8bd
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Static Public Member Functions | List of all members
BloombergLP::bmqt::QueueFlagsUtil Struct Reference

#include <bmqt_queueflags.h>

Static Public Member Functions

static bool isSet (bsls::Types::Uint64 flags, QueueFlags::Enum flag)
 
static bool isValid (bsl::ostream &errorDescription, bsls::Types::Uint64 flags)
 
static bsls::Types::Uint64 empty ()
 The empty value for flags.
 
static bool isEmpty (bsls::Types::Uint64 flags)
 Returns true if the specified flags have the empty value.
 
static bool isReader (bsls::Types::Uint64 flags)
 Returns true if the specified flags represent a reader.
 
static bool isWriter (bsls::Types::Uint64 flags)
 Returns true if the specified flags represent a writer.
 
static bool isAdmin (bsls::Types::Uint64 flags)
 Returns true if the specified flags represent an admin.
 
static bool isAck (bsls::Types::Uint64 flags)
 Returns true if the specified flags represent ack required.
 
static void setReader (bsls::Types::Uint64 *flags)
 Sets the specified flags representation for reader.
 
static void setAdmin (bsls::Types::Uint64 *flags)
 Sets the specified flags representation for admin.
 
static void setWriter (bsls::Types::Uint64 *flags)
 Sets the specified flags representation for writer.
 
static void setAck (bsls::Types::Uint64 *flags)
 Sets the specified flags representation for ack.
 
static void unsetReader (bsls::Types::Uint64 *flags)
 Resets the specified flags representation for reader.
 
static void unsetAdmin (bsls::Types::Uint64 *flags)
 Resets the specified flags representation for admin.
 
static void unsetWriter (bsls::Types::Uint64 *flags)
 Resets the specified flags representation for writer.
 
static void unsetAck (bsls::Types::Uint64 *flags)
 Resets the specified flags representation for ack.
 
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)
 

Member Function Documentation

◆ isSet()

bool BloombergLP::bmqt::QueueFlagsUtil::isSet ( bsls::Types::Uint64  flags,
QueueFlags::Enum  flag 
)
inlinestatic

Return true if the bit-mask in the specified flags has the specified flag set, or false if not.

DEPRECATED: This method is deprecated in favor of the below more specific accessors; and should be made private once all clients have been updated to the new APIs.

Referenced by isAck(), isAdmin(), isReader(), and isWriter().

◆ isValid()

static bool BloombergLP::bmqt::QueueFlagsUtil::isValid ( bsl::ostream &  errorDescription,
bsls::Types::Uint64  flags 
)
static

Check whether the specified flags represent a valid combination of flags to use for opening a queue. Return true if it does, or false if some exclusive flags are both set, and populate the specified errorDescription with the reason of the failure.

◆ empty()

bsls::Types::Uint64 BloombergLP::bmqt::QueueFlagsUtil::empty ( )
inlinestatic

Referenced by isEmpty().

◆ isEmpty()

bool BloombergLP::bmqt::QueueFlagsUtil::isEmpty ( bsls::Types::Uint64  flags)
inlinestatic

References empty().

◆ isReader()

bool BloombergLP::bmqt::QueueFlagsUtil::isReader ( bsls::Types::Uint64  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_READ, and isSet().

◆ isWriter()

bool BloombergLP::bmqt::QueueFlagsUtil::isWriter ( bsls::Types::Uint64  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_WRITE, and isSet().

◆ isAdmin()

bool BloombergLP::bmqt::QueueFlagsUtil::isAdmin ( bsls::Types::Uint64  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ADMIN, and isSet().

◆ isAck()

bool BloombergLP::bmqt::QueueFlagsUtil::isAck ( bsls::Types::Uint64  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ACK, and isSet().

◆ setReader()

void BloombergLP::bmqt::QueueFlagsUtil::setReader ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_READ.

◆ setAdmin()

void BloombergLP::bmqt::QueueFlagsUtil::setAdmin ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ADMIN.

◆ setWriter()

void BloombergLP::bmqt::QueueFlagsUtil::setWriter ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_WRITE.

◆ setAck()

void BloombergLP::bmqt::QueueFlagsUtil::setAck ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ACK.

◆ unsetReader()

void BloombergLP::bmqt::QueueFlagsUtil::unsetReader ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_READ.

◆ unsetAdmin()

void BloombergLP::bmqt::QueueFlagsUtil::unsetAdmin ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ADMIN.

◆ unsetWriter()

void BloombergLP::bmqt::QueueFlagsUtil::unsetWriter ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_WRITE.

◆ unsetAck()

void BloombergLP::bmqt::QueueFlagsUtil::unsetAck ( bsls::Types::Uint64 *  flags)
inlinestatic

References BloombergLP::bmqt::QueueFlags::e_ACK.

◆ additions()

static bsls::Types::Uint64 BloombergLP::bmqt::QueueFlagsUtil::additions ( bsls::Types::Uint64  oldFlags,
bsls::Types::Uint64  newFlags 
)
static

Return a new flag mask that only set bits are the ones that are in the specified newFlags and not in the specified oldFlags.

◆ removals()

static bsls::Types::Uint64 BloombergLP::bmqt::QueueFlagsUtil::removals ( bsls::Types::Uint64  oldFlags,
bsls::Types::Uint64  newFlags 
)
static

Return a new flag mask that only set bits are the ones that are in the specified oldFlags and not in the specified newFlags.

◆ prettyPrint()

static bsl::ostream & BloombergLP::bmqt::QueueFlagsUtil::prettyPrint ( bsl::ostream &  stream,
bsls::Types::Uint64  flags 
)
static

Print the ascii-representation of all the values set in the specified flags to the specified stream. Each value is , separated.

◆ fromString()

static int BloombergLP::bmqt::QueueFlagsUtil::fromString ( bsl::ostream &  errorDescription,
bsls::Types::Uint64 *  out,
const bsl::string &  str 
)
static

Convert the string representation of the enum bit mask from the specified str (which format corresponds to the one of the prettyPrint method) and populate the specified out with the result on success returning 0, or return a non-zero error code on error, populating the specified errorDescription with a description of the error.

The documentation for this struct was generated from the following file: