timerserviceprovider.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014,2016 - Adjacent Link LLC, Bridgewater,
 * New Jersey
 * Copyright (c) 2010 - DRS CenGen, LLC, Columbia, Maryland
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of DRS CenGen, LLC nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMNAETIMERSERVICEPROVIDER_HEADER_
#define EMNAETIMERSERVICEPROVIDER_HEADER_

#include "emane/types.h"

#include <functional>
#include <chrono>

namespace EMANE
{

  class TimerServiceProvider
  {
  public:
    virtual ~TimerServiceProvider(){};


    virtual bool cancelTimedEvent(TimerEventId eventId) = 0;


    virtual TimerEventId scheduleTimedEvent(const TimePoint & timePoint,
                                            const void * arg = nullptr,
                                            const Duration & interval = Duration::zero()) = 0;


    template <typename Function>
    TimerEventId schedule(Function fn,
                          const TimePoint & timePoint,
                          const Duration & interval = Duration::zero());

    using TimerCallback = std::function<void(const TimePoint &, // expireTime,
                                             const TimePoint &, // scheduleTime,
                                             const TimePoint &)>;// fireTime

  protected:
    virtual TimerEventId schedule_i(TimerCallback callback,
                                    const TimePoint & timePoint,
                                    const Duration & interval) = 0;

    TimerServiceProvider(){};
  };
}

#include "emane/timerserviceprovider.inl"

#endif //EMNAETIMERSERVICEPROVIDER_HEADER_