bmqt::QueueFlagsUtil Struct Reference

#include <bmqt_queueflags.h>

List of all members.

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 ()
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)

---

Member Function Documentation

static bool bmqt::QueueFlagsUtil::isSet	(	bsls::Types::Uint64	flags,
		QueueFlags::Enum	flag
	)			[static]

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.

static bool 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.

static bsls::Types::Uint64 bmqt::QueueFlagsUtil::empty

(

)

[static]

The empty value for flags.

static bool bmqt::QueueFlagsUtil::isEmpty

(

bsls::Types::Uint64

flags

)

[static]

Returns true if the specified flags have the empty value.

static bool bmqt::QueueFlagsUtil::isReader

(

bsls::Types::Uint64

flags

)

[static]

Returns true if the specified flags represent a reader.

static bool bmqt::QueueFlagsUtil::isWriter

(

bsls::Types::Uint64

flags

)

[static]

Returns true if the specified flags represent a writer.

static bool bmqt::QueueFlagsUtil::isAdmin

(

bsls::Types::Uint64

flags

)

[static]

Returns true if the specified flags represent an admin.

static bool bmqt::QueueFlagsUtil::isAck

(

bsls::Types::Uint64

flags

)

[static]

Returns true if the specified flags represent ack required.

static void bmqt::QueueFlagsUtil::setReader

(

bsls::Types::Uint64 *

flags

)

[static]

Sets the specified flags representation for reader.

static void bmqt::QueueFlagsUtil::setAdmin

(

bsls::Types::Uint64 *

flags

)

[static]

Sets the specified flags representation for admin.

static void bmqt::QueueFlagsUtil::setWriter

(

bsls::Types::Uint64 *

flags

)

[static]

Sets the specified flags representation for writer.

static void bmqt::QueueFlagsUtil::setAck

(

bsls::Types::Uint64 *

flags

)

[static]

Sets the specified flags representation for ack.

static void bmqt::QueueFlagsUtil::unsetReader

(

bsls::Types::Uint64 *

flags

)

[static]

Resets the specified flags representation for reader.

static void bmqt::QueueFlagsUtil::unsetAdmin

(

bsls::Types::Uint64 *

flags

)

[static]

Resets the specified flags representation for admin.

static void bmqt::QueueFlagsUtil::unsetWriter

(

bsls::Types::Uint64 *

flags

)

[static]

Resets the specified flags representation for writer.

static void bmqt::QueueFlagsUtil::unsetAck

(

bsls::Types::Uint64 *

flags

)

[static]

Resets the specified flags representation for ack.

static bsls::Types::Uint64 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.

static bsls::Types::Uint64 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.

static bsl::ostream& 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.

static int 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:

• bmqt_queueflags.h