Thread.h

Go to the documentation of this file.

// %flair:license{
// This file is part of the Flair framework distributed under the
// CECILL-C License, Version 1.0.
// %flair:license}
#ifndef THREAD_H
#define THREAD_H

#include <Object.h>
#include <stdint.h>

class Thread_impl;

namespace flair {
namespace core {

class IODevice;

class Thread : public Object {
  friend class ::Thread_impl;

public:
  Thread(const Object *parent, std::string name,
         uint8_t priority,uint32_t stackSize=1024*128);

  virtual ~Thread();

  void Start(void);

  void SafeStop(void);

  bool ToBeStopped(void) const;

  void Join(void);

  void SetPeriodUS(uint32_t period_us);

  uint32_t GetPeriodUS() const;

  void SetPeriodMS(uint32_t period_ms);

  uint32_t GetPeriodMS() const;

  bool IsPeriodSet(void);

  void WaitPeriod(void) const;

  int WaitUpdate(const IODevice *device);

  void Suspend(void);

  bool SuspendUntil(Time date);

  void Resume(void);

  bool IsSuspended(void) const;
  
  bool IsRunning(void) const;

  void SleepUntil(Time time) const;

  void SleepUS(uint32_t time_us) const;

  void SleepMS(uint32_t time_ms) const;

  static void WarnUponSwitches(bool enable);

private:
  virtual void Run(void) = 0;

  class Thread_impl *pimpl_;
};

} // end namespace core
} // end namespace flair

#endif // THREAD_H