al_PeriodicThread.hpp

#ifndef INCLUDE_AL_PERIODIC_THREAD_HPP
#define INCLUDE_AL_PERIODIC_THREAD_HPP
 
/*  Allocore --
        Multimedia / virtual environment application class library
 
        Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012. The Regents of the University of California. 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 the University of California 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 HOLDER 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.
 
 
        File description:
        Thread that calls a function periodically
 
        File author(s):
        Lance Putnam, 2013, putnam.lance@gmail.com
*/
#include <functional>
 
#include "al/system/al_Thread.hpp"
#include "al/system/al_Time.hpp"
 
namespace al {
 
 
class PeriodicThread : public Thread {
 public:
  PeriodicThread(double periodSec = 1);
 
  PeriodicThread(const PeriodicThread& other);
 
 
  PeriodicThread& autocorrect(float factor);
 
  PeriodicThread& period(double sec);
 
  double period() const;
 
  void start(ThreadFunction& func);
 
  void start(std::function<void(void* data)> function,
             void* userData = nullptr);
 
  void stop();
 
  bool running() const;
 
  // Stuff for assignment
  friend void swap(PeriodicThread& a, PeriodicThread& b);
  PeriodicThread& operator=(PeriodicThread other);
 
 private:
  static void* sPeriodicFunc(void* userData);
  void go();
 
  al_nsec mPeriod;
  al_nsec mTimeCurr, mTimePrev;  // time measurements between frames
  al_nsec mWait;                 // actual time to sleep between frames
  al_nsec mTimeBehind;
  float mAutocorrect;
  ThreadFunction* mUserFunc;
  void* mUserData;
  std::function<void(void* data)> mFunction;
  bool mRun;
};
 
}  // namespace al
 
#endif