scheduleRecurringEvent overloads

Synopses

Declared in <bdlmt_eventscheduler.h>

Schedule a recurring event that invokes callback at interval.

void
scheduleRecurringEvent(
    bsls::TimeInterval const& interval,
    bsl::function<void()> const& callback,
    bsls::TimeInterval const& startEpochTime = bsls::TimeInterval(0));

Schedule a recurring event that invokes callback at interval.

template<
    class t_CLOCK,
    class t_REP_TYPE,
    class t_PERIOD_TYPE,
    class t_DURATION>
void
scheduleRecurringEvent(
    bsl::chrono::duration<t_REP_TYPE, t_PERIOD_TYPE> const& interval,
    bsl::function<void()> const& callback,
    bsl::chrono::time_point<t_CLOCK, t_DURATION> const& startEpochTime = t_CLOCK::now());

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

void
scheduleRecurringEvent(
    RecurringEventHandle* event,
    bsls::TimeInterval const& interval,
    bsl::function<void()> const& callback,
    bsls::TimeInterval const& startEpochTime = bsls::TimeInterval(0));

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

template<
    class t_CLOCK,
    class t_REP_TYPE,
    class t_PERIOD_TYPE,
    class t_DURATION>
void
scheduleRecurringEvent(
    RecurringEventHandle* event,
    bsl::chrono::duration<t_REP_TYPE, t_PERIOD_TYPE> const& interval,
    bsl::function<void()> const& callback,
    bsl::chrono::time_point<t_CLOCK, t_DURATION> const& startEpochTime = t_CLOCK::now());

Parameters

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

Created with MrDocs