bmqt::GenericResult Struct Reference

#include <bmqt_resultcode.h>

List of all members.

Public Types
enum	Enum {   e_SUCCESS = 0, e_UNKNOWN = -1, e_TIMEOUT = -2, e_NOT_CONNECTED = -3,   e_CANCELED = -4, e_NOT_SUPPORTED = -5, e_REFUSED = -6, e_INVALID_ARGUMENT = -7,   e_NOT_READY = -8, e_LAST = e_NOT_READY }
Static Public Member Functions
static bsl::ostream &	print (bsl::ostream &stream, GenericResult::Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (GenericResult::Enum value)
static bool	fromAscii (GenericResult::Enum *out, const bslstl::StringRef &str)

---

Detailed Description

This enum represents generic common status

See Component bmqt_resultcode

---

Member Enumeration Documentation

enum bmqt::GenericResult::Enum

Enumerator:

e_SUCCESS	Operation was success.
e_UNKNOWN	Operation failed for unknown reason.
e_TIMEOUT	Operation timedout.
e_NOT_CONNECTED	Cant process, not connected to the broker.
e_CANCELED	Operation was canceled.
e_NOT_SUPPORTED	Operation is not supported.
e_REFUSED	Operation was refused.
e_INVALID_ARGUMENT	An invalid argument was provided.
e_NOT_READY	Not ready to process the request.
e_LAST	Used in test driver only, to validate consistency between this enum and the bmqp_ctrlmsg.xsd::StatusCategory one

---

Member Function Documentation

static bsl::ostream& bmqt::GenericResult::print	(	bsl::ostream &	stream,
		GenericResult::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.

static const char* bmqt::GenericResult::toAscii

(

GenericResult::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.

static bool bmqt::GenericResult::fromAscii	(	GenericResult::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.

---

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

• bmqt_resultcode.h