bdlmt::EventSchedulerEventHandle Class Reference

#include <bdlmt_eventscheduler.h>

Detailed Description

Objects of this type refer to events in the EventScheduler API. They are convertible to const Event* references and may be used in any method that expects them.

Public Types
typedef EventScheduler::Event	Event

Public Member Functions
	EventSchedulerEventHandle ()
	EventSchedulerEventHandle (const EventSchedulerEventHandle &original)
	~EventSchedulerEventHandle ()
EventSchedulerEventHandle &	operator= (const EventSchedulerEventHandle &rhs)
void	release ()
	operator const Event * () const

Friends
class	EventScheduler

Member Typedef Documentation

Event

typedef EventScheduler::Event bdlmt::EventSchedulerEventHandle::Event

Constructor & Destructor Documentation

EventSchedulerEventHandle() [1/2]

bdlmt::EventSchedulerEventHandle::EventSchedulerEventHandle ( )

inline

Create a new handle object that does not refer to an event.

EventSchedulerEventHandle() [2/2]

bdlmt::EventSchedulerEventHandle::EventSchedulerEventHandle ( const EventSchedulerEventHandle &  original )

inline

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

~EventSchedulerEventHandle()

bdlmt::EventSchedulerEventHandle::~EventSchedulerEventHandle ( )

inline

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

Member Function Documentation

operator const Event *()

bdlmt::EventSchedulerEventHandle::operator const Event *

(

)

const

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

operator=()

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

inline

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

release()

void bdlmt::EventSchedulerEventHandle::release ( )

inline

Release the reference (if any) held by this object.

Friends And Related Symbol Documentation

EventScheduler

friend class EventScheduler

friend

---

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

• bdlmt_eventscheduler.h