Handle referring to a recurring event in an EventScheduler.

Synopsis

Declared in <bdlmt_eventscheduler.h>

class EventSchedulerRecurringEventHandle;

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.

Type Aliases

Name

Description

RecurringEvent

Defines a type alias for the opaque recurring‐event type.

Member Functions

Name

Description

EventSchedulerRecurringEventHandle [constructor]

Constructors

~EventSchedulerRecurringEventHandle [destructor]

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

operator=

Assign this handle to refer to the same event as rhs.

release

Release the reference managed by this handle, if any.

operator bdlmt::EventSchedulerRecurringEventHandle::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

Name

Description

BloombergLP::bdlmt::EventScheduler

Thread‐safe scheduler that dispatches callbacks on a worker thread.

Created with MrDocs