code::LBActionSource::LBEvent Class Reference

Inheritance diagram for code::LBActionSource::LBEvent:

List of all members.

---

Detailed Description

LBEvent is the ActionEvent posted by the LBActionSource.

The ActionSource contained is therefore a LBActionSource.

Author:

Lakshman

Version:

Id

code_LBActionSource.h,v 1.5 2009/06/02 20:17:38 lakshman Exp

See also:

LBActionSource

Public Member Functions
	LBEvent (LBActionSource *s, const std::string &typ, LB_id_t mid, int mlen)
	This constructor is called only by the LBActionSource which owns this object.
ActionSource *	getSource () const
	Returns a pointer to the object that generated this ActionEvent.
const std::string &	getType () const
	Returns a source-specific type identifier to indicate what action occurred.
Public Attributes
LB_id_t	msg_id
	The id of the message (new/expired).
int	msg_len
	The length of the new message.
Static Public Attributes
static const std::string	NewMessage
	Event type: NewMessage.
static const std::string	MsgExpired
	Event type: MsgExpired.

---

Constructor & Destructor Documentation

code::LBActionSource::LBEvent::LBEvent	(	LBActionSource *	s,
		const std::string &	typ,
		LB_id_t	mid,
		int	mlen
	)			[inline]

This constructor is called only by the LBActionSource which owns this object.

---

Member Function Documentation

ActionSource* code::ActionEvent::getSource

(

)

const [inline, inherited]

Returns a pointer to the object that generated this ActionEvent.

Returns:

a pointer to the object that generated this ActionEvent.

const std::string& code::ActionEvent::getType

(

)

const [inline, inherited]

Returns a source-specific type identifier to indicate what action occurred.

Returns:

a source-specific type identifier to indicate what action occurred.

---

Member Data Documentation

LB_id_t code::LBActionSource::LBEvent::msg_id

The id of the message (new/expired).

int code::LBActionSource::LBEvent::msg_len

The length of the new message.

For expired messages, it is always zero.

const std::string code::LBActionSource::LBEvent::MsgExpired [static]

Event type: MsgExpired.

Posted when a message is aged off the LB

const std::string code::LBActionSource::LBEvent::NewMessage [static]

Event type: NewMessage.

Posted when a new message is added to the LB.

---