include/pedigree/kernel/machine/SchedulerTimer.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef KERNEL_MACHINE_SCHEDULERTIMER_H
#define KERNEL_MACHINE_SCHEDULERTIMER_H
#include "pedigree/kernel/processor/types.h"
 
class SchedulerTimerHandler;
 
class SchedulerTimer {
 public:
  virtual bool registerHandler(SchedulerTimerHandler* handler) = 0;
  virtual uint64_t nominalQuantumNs() const = 0;
  virtual bool supportsOneShot() const {
    return false;
  }
  virtual bool armDeadline(uint64_t) {
    return false;
  }
  virtual void disarm() {}
  virtual bool removeHandler(SchedulerTimerHandler* handler) = 0;
 
 protected:
  SchedulerTimer();
  virtual ~SchedulerTimer();
 
  static bool canRemoveHandlerInCurrentContext();
 
 private:
  SchedulerTimer(const SchedulerTimer&);
  SchedulerTimer& operator=(const SchedulerTimer&);
};
 
#endif