bmqt_resultcode.h File Reference

Provide enums for various publicly exposed result code. More...

#include <bsl_iosfwd.h>
#include <bsl_string.h>

Go to the source code of this file.

Classes
struct	BloombergLP::bmqt::GenericResult
	This enum represents generic common status. More...
struct	BloombergLP::bmqt::OpenQueueResult
	This enum represents the result of an openQueue operation. More...
struct	BloombergLP::bmqt::ConfigureQueueResult
	This enum represents the result of a configureQueue operation. More...
struct	BloombergLP::bmqt::CloseQueueResult
	This enum represents the result of a closeQueue operation. More...
struct	BloombergLP::bmqt::EventBuilderResult
struct	BloombergLP::bmqt::AckResult
	This enum represents the result code status of an ack message. More...
struct	BloombergLP::bmqt::PostResult
	This enum represents the result code status of a post message. More...

Namespaces
	BloombergLP
	BloombergLP::bmqt

Functions
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, GenericResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, OpenQueueResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, ConfigureQueueResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, CloseQueueResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, EventBuilderResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, AckResult::Enum value)
bsl::ostream &	BloombergLP::bmqt::operator<< (bsl::ostream &stream, PostResult::Enum value)

Detailed Description

This file contains a list of Enums (bmqt::GenericResult, bmqt::AckResult, bmqt::CloseQueueResult, bmqt::EventBuilderResult, bmqt::OpenQueueResult, bmqt::ConfigureQueueResult, and bmqt::PostResult) that are publicly exposed to Application (via bmqa), but whose value comes from the internal implementation (bmqimp). Having them defined in bmqt allows bmqa to return the enum returned by bmqimp with no transformation.

All enums are using the convention that < 0 values are errors, while > 0 are warnings.

The bmqt::GenericResult enum contains values that are common for most or all of the other status enums, such as success, timeout, ... The values of its members can range from -99 to 99.

Each other enum should duplicate any values from the bmqt::GenericResult one that it intends to be able to represent (aliasing the values to the ones from the bmqt::GenericResult enum) and extend with specialized values in the ]..., -99[ or ]99, ...[ ranges.