[#BloombergLP-bdlmt-EventSchedulerRecurringEventHandle]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::EventSchedulerRecurringEventHandle
:relfileprefix: ../../
:mrdocs:

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.

== Synopsis

Declared in `<bdlmt_eventscheduler.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class EventSchedulerRecurringEventHandle;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/RecurringEvent.adoc[`RecurringEvent`] 
| Defines a type alias for the opaque recurring‐event type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/2constructor-0a.adoc[`EventSchedulerRecurringEventHandle`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/2destructor.adoc[`~EventSchedulerRecurringEventHandle`] [.small]#[destructor]#
| Destroy this object and release the managed reference, if any.
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/operator_assign.adoc[`operator=`] 
| 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.
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/release.adoc[`release`] 
| Release the reference managed by this handle, if any.
| xref:BloombergLP/bdlmt/EventSchedulerRecurringEventHandle/2conversion.adoc[`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

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlmt/EventScheduler.adoc[BloombergLP::bdlmt::EventScheduler]`
| This class provides a thread‐safe event scheduler that executes callbacks in a separate "dispatcher thread." `start` must be invoked to start dispatching the callbacks. `stop` pauses the dispatching of the callbacks without removing the pending events.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#