bdlmt::EventSchedulerRecurringEventHandle Class Reference

#include <bdlmt_eventscheduler.h>

Public Types
typedef EventScheduler::RecurringEvent	RecurringEvent

Public Member Functions
	EventSchedulerRecurringEventHandle ()
	Create a new handle object.
	EventSchedulerRecurringEventHandle (const EventSchedulerRecurringEventHandle &original)
	~EventSchedulerRecurringEventHandle ()
	Destroy this object and release the managed reference, if any.
EventSchedulerRecurringEventHandle &	operator= (const EventSchedulerRecurringEventHandle &rhs)
void	release ()
	Release the reference managed by this handle, if any.
	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.

Member Typedef Documentation

RecurringEvent

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

Constructor & Destructor Documentation

EventSchedulerRecurringEventHandle() [1/2]

bdlmt::EventSchedulerRecurringEventHandle::EventSchedulerRecurringEventHandle ( )

inline

EventSchedulerRecurringEventHandle() [2/2]

bdlmt::EventSchedulerRecurringEventHandle::EventSchedulerRecurringEventHandle ( const EventSchedulerRecurringEventHandle &  original )

inline

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

~EventSchedulerRecurringEventHandle()

bdlmt::EventSchedulerRecurringEventHandle::~EventSchedulerRecurringEventHandle ( )

inline

Member Function Documentation

operator const RecurringEvent *()

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.

operator=()

EventSchedulerRecurringEventHandle & bdlmt::EventSchedulerRecurringEventHandle::operator= ( const EventSchedulerRecurringEventHandle &  rhs )

inline

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.

release()

void bdlmt::EventSchedulerRecurringEventHandle::release ( )

inline

Friends And Related Symbol Documentation

EventScheduler

friend class EventScheduler

friend

---

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

• bdlmt_eventscheduler.h