bmqt::SessionEventType Struct Reference

#include <bmqt_sessioneventtype.h>

List of all members.

Public Types
enum	Enum {   e_ERROR = -1, e_TIMEOUT = -2, e_CANCELED = -3, e_UNDEFINED = 0,   e_CONNECTED = 1, e_DISCONNECTED = 2, e_CONNECTION_LOST = 3, e_RECONNECTED = 4,   e_STATE_RESTORED = 5, e_CONNECTION_TIMEOUT = 6, e_QUEUE_OPEN_RESULT = 7, e_QUEUE_REOPEN_RESULT = 8,   e_QUEUE_CLOSE_RESULT = 9, e_SLOWCONSUMER_NORMAL = 10, e_SLOWCONSUMER_HIGHWATERMARK = 11, e_QUEUE_CONFIGURE_RESULT = 12,   e_HOST_UNHEALTHY = 13, e_HOST_HEALTH_RESTORED = 14, e_QUEUE_SUSPENDED = 15, e_QUEUE_RESUMED = 16 }
Static Public Member Functions
static bsl::ostream &	print (bsl::ostream &stream, SessionEventType::Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (SessionEventType::Enum value)
static bool	fromAscii (SessionEventType::Enum *out, const bslstl::StringRef &str)

---

Detailed Description

Enumeration for the types of session events

See Component bmqt_sessioneventtype

---

Member Enumeration Documentation

enum bmqt::SessionEventType::Enum

Enumerator:

e_ERROR	Generic error.
e_TIMEOUT	Time out of the operation.
e_CANCELED	The operation was canceled.
e_UNDEFINED
e_CONNECTED	Session started.
e_DISCONNECTED	Session terminated.
e_CONNECTION_LOST	Lost connection to the broker.
e_RECONNECTED	Reconnected with the broker.
e_STATE_RESTORED	Client's state has been restored.
e_CONNECTION_TIMEOUT	The connection to broker timedOut.
e_QUEUE_OPEN_RESULT	Result of openQueue operation.
e_QUEUE_REOPEN_RESULT	Result of re-openQueue operation.
e_QUEUE_CLOSE_RESULT	Result of closeQueue operation.
e_SLOWCONSUMER_NORMAL	EventQueue is at lowWatermark.
e_SLOWCONSUMER_HIGHWATERMARK	EventQueue is at highWatermark.
e_QUEUE_CONFIGURE_RESULT	Result of configureQueue.
e_HOST_UNHEALTHY	Host has become unhealthy.
e_HOST_HEALTH_RESTORED	Host's health has been restored.
e_QUEUE_SUSPENDED	Queue has suspended operation.
e_QUEUE_RESUMED	Queue has resumed operation.

---

Member Function Documentation

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

static const char* bmqt::SessionEventType::toAscii

(

SessionEventType::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 BMQT_ 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::SessionEventType::fromAscii	(	SessionEventType::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_sessioneventtype.h