oneshot_alarm.h

/*
 *     .============.
 *    //  M A K E  / \
 *   //  C++ DEV  /   \
 *  //  E A S Y  /  \/ \
 * ++ ----------.  \/\  .
 *  \\     \     \ /\  /
 *   \\     \     \   /
 *    \\     \     \ /
 *     -============'
 *
 * Copyright (c) 2018 Hevake and contributors, all rights reserved.
 *
 * This file is part of cpp-tbox (https://github.com/cpp-main/cpp-tbox)
 * Use of this source code is governed by MIT license that can be found
 * in the LICENSE file in the root of the source tree. All contributing
 * project authors may be found in the CONTRIBUTORS.md file in the root
 * of the source tree.
 */
#ifndef TBOX_ALARM_ONESHOT_ALARM_H_20221023
#define TBOX_ALARM_ONESHOT_ALARM_H_20221023

#include "alarm.h"

namespace tbox {
namespace alarm {

/*
 * @brief The oneshot alarm.
 *
 * OneshotAlarm allow the user to make plans which execute at today or tomorrow
 * If the specified time is later than the local time, the system will execute today.
 * Otherwise it will be executed tomorrow.
 *
 * code example:
 *
 * Loop *loop = Loop::New();
 *
 * OneshotAlarm tmr(loop);
 * tmr.initialize(30600); // at 08:30
 * tmr.setCallback([] { std::cout << "time is up" << endl;});
 * tmr.enable();
 *
 * loop->runLoop();
 */
class OneshotAlarm : public Alarm
{
  public:
    using Alarm::Alarm;

    /**
     * \brief 初始化
     *
     * \param seconds_of_day  从本地00:00起到触发时间的秒数
     *                        如：08:30 = 8 * 3600 + 30 * 60 = 30600
     */
    bool initialize(int seconds_of_day);

  protected:
    virtual bool calculateNextLocalTimeSec(uint32_t curr_local_sec, uint32_t &next_local_sec) override;

    virtual void onTimeExpired() override;

  private:
    int seconds_of_day_ = 0;
};

}
}

#endif //TBOX_ALARM_ONESHOT_ALARM_H_20221023