bdlmt::EventSchedulerRecurringEventHandle Class Reference

#include <bdlmt_eventscheduler.h>

List of all members.

Public Types
typedef EventScheduler::RecurringEvent	RecurringEvent
Public Member Functions
	EventSchedulerRecurringEventHandle ()
	EventSchedulerRecurringEventHandle (const EventSchedulerRecurringEventHandle &original)
	~EventSchedulerRecurringEventHandle ()
EventSchedulerRecurringEventHandle &	operator= (const EventSchedulerRecurringEventHandle &rhs)
void	release ()
	operator const RecurringEvent * () const
Friends
class	EventScheduler

---

Detailed Description

Objects of this type refer to recurring events in the EventScheduler API. They are convertible to const RecurringEvent* references and may be used in any method which expects these.

See Component bdlmt_eventscheduler

---

Member Typedef Documentation

typedef EventScheduler::RecurringEvent bdlmt::EventSchedulerRecurringEventHandle::RecurringEvent

---

Constructor & Destructor Documentation

bdlmt::EventSchedulerRecurringEventHandle::EventSchedulerRecurringEventHandle

(

)

Create a new handle object.

bdlmt::EventSchedulerRecurringEventHandle::EventSchedulerRecurringEventHandle

(

const EventSchedulerRecurringEventHandle &

original

)

Create a new handle object referring to the same recurring event as the specified rhs handle.

bdlmt::EventSchedulerRecurringEventHandle::~EventSchedulerRecurringEventHandle

(

)

Destroy this object and release the managed reference, if any.

---

Member Function Documentation

EventSchedulerRecurringEventHandle& bdlmt::EventSchedulerRecurringEventHandle::operator=

(

const EventSchedulerRecurringEventHandle &

rhs

)

Release the reference managed by this handle, if any; then make this handle refer to the same recurring event as the specified rhs handle. Return a modifiable reference to this event handle.

void bdlmt::EventSchedulerRecurringEventHandle::release

(

)

Release the reference managed by this handle, if any.

bdlmt::EventSchedulerRecurringEventHandle::operator const RecurringEvent *

(

)

const

Return a "raw" pointer to the recurring event managed by this handle, or 0 if this handle does not manage a reference.

---

Friends And Related Function Documentation

friend class EventScheduler [friend]

---

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

• bdlmt_eventscheduler.h