Quick Links:

bal | bbl | bdl | bsl

Public Types | Public Member Functions | Friends

bdlmt::EventSchedulerEventHandle Class Reference

#include <bdlmt_eventscheduler.h>

List of all members.

Public Types

typedef EventScheduler::Event Event

Public Member Functions

 EventSchedulerEventHandle ()
 EventSchedulerEventHandle (const EventSchedulerEventHandle &original)
 ~EventSchedulerEventHandle ()
EventSchedulerEventHandleoperator= (const EventSchedulerEventHandle &rhs)
void release ()
 operator const Event * () const

Friends

class EventScheduler

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.

See Component bdlmt_eventscheduler


Member Typedef Documentation


Constructor & Destructor Documentation

bdlmt::EventSchedulerEventHandle::EventSchedulerEventHandle (  ) 

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

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

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

bdlmt::EventSchedulerEventHandle::~EventSchedulerEventHandle (  ) 

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


Member Function Documentation

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

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.

void bdlmt::EventSchedulerEventHandle::release (  ) 

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

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.


Friends And Related Function Documentation

friend class EventScheduler [friend]

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