YansCoreNS::TimerEvent Class Reference

Denotes a custom scheduled time. More...

Inheritance diagram for YansCoreNS::TimerEvent:

List of all members.

Public Member Functions
boost::shared_ptr < TimerEventData const >	GetData (void) const
	Returns the sender of the event.
EventProcessor &	GetSender (void) const
	Returns the sender of the event.
	TimerEvent (EventProcessor &sender, boost::shared_ptr< const TimerEventData > data=boost::shared_ptr< const TimerEventData >())
	Constructor.
virtual	~TimerEvent (void)
	Destructor.

---

Detailed Description

Denotes a custom scheduled time.

Note:

Timer events are useful for scheduling activities (especially ones that might be augmented by other future events) in the future.

---

Constructor & Destructor Documentation

YansCoreNS::TimerEvent::TimerEvent	(	EventProcessor &	sender,
		boost::shared_ptr< const TimerEventData >	data = boost::shared_ptr< const TimerEventData >()
	)			[explicit]

Constructor.

Parameters:

[in]	sender	The sender of this event.
[in]	data	Data associated with this event. Can be NULL.

virtual YansCoreNS::TimerEvent::~TimerEvent

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

boost::shared_ptr<TimerEventData const> YansCoreNS::TimerEvent::GetData

(

void

)

const

Returns the sender of the event.

EventProcessor& YansCoreNS::TimerEvent::GetSender

(

void

)

const

Returns the sender of the event.

See also:

The constructor, YansCoreNS::TimerEvent::TimerEvent().