[#BloombergLP-bdlmt-EventScheduler-scheduleRecurringEvent-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/EventScheduler.adoc[EventScheduler]::scheduleRecurringEvent
:relfileprefix: ../../../
:mrdocs:

`scheduleRecurringEvent` overloads

== Synopses

Declared in `<bdlmt_eventscheduler.h>`

Schedule a recurring event that invokes `callback` at `interval`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-01.adoc[scheduleRecurringEvent](
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& interval,
    xref:bsl/function-0a.adoc[bsl::function<void()>] const& callback,
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& startEpochTime = bsls::TimeInterval(0));
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-01.adoc[_» more..._]#

Schedule a recurring event that invokes `callback` at `interval`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_CLOCK,
    class t_REP_TYPE,
    class t_PERIOD_TYPE,
    class t_DURATION>
void
xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-0d.adoc[scheduleRecurringEvent](
    bsl::chrono::duration<t_REP_TYPE, t_PERIOD_TYPE> const& interval,
    xref:bsl/function-0a.adoc[bsl::function<void()>] const& callback,
    bsl::chrono::time_point<t_CLOCK, t_DURATION> const& startEpochTime = t_CLOCK::now());
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-0d.adoc[_» more..._]#

Same as the preceding overload, loading a cancel handle into `event`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-028d.adoc[scheduleRecurringEvent](
    xref:BloombergLP/bdlmt/EventScheduler/RecurringEventHandle.adoc[RecurringEventHandle]* event,
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& interval,
    xref:bsl/function-0a.adoc[bsl::function<void()>] const& callback,
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& startEpochTime = bsls::TimeInterval(0));
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-028d.adoc[_» more..._]#

Same as the preceding overload, loading a cancel handle into `event`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_CLOCK,
    class t_REP_TYPE,
    class t_PERIOD_TYPE,
    class t_DURATION>
void
xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-0287.adoc[scheduleRecurringEvent](
    xref:BloombergLP/bdlmt/EventScheduler/RecurringEventHandle.adoc[RecurringEventHandle]* event,
    bsl::chrono::duration<t_REP_TYPE, t_PERIOD_TYPE> const& interval,
    xref:bsl/function-0a.adoc[bsl::function<void()>] const& callback,
    bsl::chrono::time_point<t_CLOCK, t_DURATION> const& startEpochTime = t_CLOCK::now());
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/scheduleRecurringEvent-0287.adoc[_» more..._]#

== Parameters

[cols="1,4"]
|===
| Name| Description
| *interval*
| period between recurring dispatches
| *callback*
| function invoked when the event is dispatched
| *startEpochTime*
| absolute time of the first dispatch
| *event*
| receives a handle that can cancel the event
|===


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