bmqa::SessionEvent Class Reference

#include <bmqa_sessionevent.h>

List of all members.

Public Member Functions
	SessionEvent ()
	SessionEvent (const SessionEvent &other)
SessionEvent &	operator= (const SessionEvent &rhs)
bmqt::SessionEventType::Enum	type () const
const bmqt::CorrelationId &	correlationId () const
QueueId	queueId () const
int	statusCode () const
const bsl::string &	errorDescription () const
bsl::ostream &	print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const
Friends
bool	operator== (const SessionEvent &lhs, const SessionEvent &rhs)
bool	operator!= (const SessionEvent &lhs, const SessionEvent &rhs)

---

Detailed Description

An event related to the operation of a Session.

See Component bmqa_sessionevent

---

Constructor & Destructor Documentation

bmqa::SessionEvent::SessionEvent

(

)

[explicit]

Default constructor

bmqa::SessionEvent::SessionEvent

(

const SessionEvent &

other

)

Create a new SessionEvent having the same values (pointing to the same pimpl) as the specified other.

---

Member Function Documentation

SessionEvent& bmqa::SessionEvent::operator=

(

const SessionEvent &

rhs

)

Assign to this SessionEvent the same values as the one from the specified rhs (i.e., reference the same pimpl).

bmqt::SessionEventType::Enum bmqa::SessionEvent::type

(

)

const

Return the session event type.

const bmqt::CorrelationId& bmqa::SessionEvent::correlationId

(

)

const

Return the correlationId associated to this event, if any.

QueueId bmqa::SessionEvent::queueId

(

)

const

Return the queueId associated to this event, if any. The behavior is undefined unless this event corresponds to a queue related event (i.e. OPEN, CONFIGURE, CLOSE, REOPEN).

int bmqa::SessionEvent::statusCode

(

)

const

Return the status code that indicates success or the cause of a failure.

const bsl::string& bmqa::SessionEvent::errorDescription

(

)

const

Return a printable description of the error, if statusCode returns non-zero. Return an empty string otherwise.

bsl::ostream& bmqa::SessionEvent::print	(	bsl::ostream &	stream,
		int	level = 0,
		int	spacesPerLevel = 4
	)			const

Format this object to the specified output stream at the (absolute value of) the optionally specified indentation level and return a reference to stream. If level is specified, optionally specify spacesPerLevel, 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). If stream is not valid on entry, this operation has no effect.

---

Friends And Related Function Documentation

bool operator==	(	const SessionEvent &	lhs,
		const SessionEvent &	rhs
	)			[friend]

Return true if the specified rhs object contains the value of the same type as contained in the specified lhs object and the value itself is the same in both objects, return false otherwise.

bool operator!=	(	const SessionEvent &	lhs,
		const SessionEvent &	rhs
	)			[friend]

Return false if the specified rhs object contains the value of the same type as contained in the specified lhs object and the value itself is the same in both objects, return true otherwise.

---

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

• bmqa_sessionevent.h