BloombergLP::bmqt::QueueFlags Struct Reference

This enum represents queue flags.

#include <bmqt_queueflags.h>

Public Types
enum	Enum { e_ADMIN = (1 << 0) , e_READ = (1 << 1) , e_WRITE = (1 << 2) , e_ACK = (1 << 3) }

Static Public Member Functions
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)

Static Public Attributes
static const int	k_LOWEST_SUPPORTED_QUEUE_FLAG = e_ADMIN
static const int	k_HIGHEST_SUPPORTED_QUEUE_FLAG = e_ACK

Member Enumeration Documentation

Enum

enum BloombergLP::bmqt::QueueFlags::Enum

Enumerator
e_ADMIN
e_READ
e_WRITE
e_ACK

Member Function Documentation

print()

static bsl::ostream& BloombergLP::bmqt::QueueFlags::print ( bsl::ostream &  stream, QueueFlags::Enum  value, int  level = 0, int  spacesPerLevel = 4  )

static

Write the string representation of the specified enumeration value to the specified output stream, and return a reference to stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). See toAscii for what constitutes the string representation of a GenericResult::Enum value.

Referenced by BloombergLP::bmqt::operator<<().

toAscii()

static const char* BloombergLP::bmqt::QueueFlags::toAscii ( QueueFlags::Enum  value )

static

Return the non-modifiable string representation corresponding to the specified enumeration value, if it exists, and a unique (error) string otherwise. The string representation of value matches its corresponding enumerator name with the e_ prefix elided. Note that specifying a value that does not match any of the enumerators will result in a string representation that is distinct from any of those corresponding to the enumerators, but is otherwise unspecified.

fromAscii()

static bool BloombergLP::bmqt::QueueFlags::fromAscii ( QueueFlags::Enum *  out, const bslstl::StringRef &  str  )

static

Return true and fills the specified out with the enum value corresponding to the specified str, if valid, or return false and leave out untouched if str doesn't correspond to any value of the enum.

Member Data Documentation

k_LOWEST_SUPPORTED_QUEUE_FLAG

const int BloombergLP::bmqt::QueueFlags::k_LOWEST_SUPPORTED_QUEUE_FLAG = e_ADMIN

static

NOTE: This value must always be equal to the lowest type in the enum because it is being used as a lower bound to verify that a QueueFlags field is a supported type.

k_HIGHEST_SUPPORTED_QUEUE_FLAG

const int BloombergLP::bmqt::QueueFlags::k_HIGHEST_SUPPORTED_QUEUE_FLAG = e_ACK

static

NOTE: This value must always be equal to the highest supported type in the enum because it is being used to verify a QueueFlags field is a supported type.

---

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

• bmqt/bmqt_queueflags.h