icl_core_thread/Thread.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_THREAD_THREAD_H_INCLUDED
#define ICL_CORE_THREAD_THREAD_H_INCLUDED

#include <icl_core/BaseTypes.h>
#include <icl_core/Noncopyable.h>
#include <icl_core/TimeSpan.h>
#include <icl_core/TimeStamp.h>
#include <icl_core/os_thread.h>

#include "icl_core_thread/ImportExport.h"
#include "icl_core_thread/Mutex.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace thread {

class ThreadImpl;

class ICL_CORE_THREAD_IMPORT_EXPORT Thread : protected virtual icl_core::Noncopyable
{
public:
  Thread(const icl_core::String& description, icl_core::ThreadPriority priority = 0);

  virtual ~Thread();

  void cancel();

  bool checkHardRealtime();

  icl_core::String getDescription() const;

  bool execute() const { return m_execute; }

  bool isHardRealtime() const;

  bool executesHardRealtime() const;

  void join();

  icl_core::ThreadPriority priority() const;

  virtual void onStop() { }

  virtual void run() = 0;

  bool running() const { return !m_finished; }

  void setDescription(const icl_core::String& description);

  bool setHardRealtime(bool hard_realtime = true);

  bool setPriority(icl_core::ThreadPriority priority);

  bool start();

  void stop() { waitStarted(); m_execute = false; }

  icl_core::ThreadId threadId() const;

  const char *threadInfo() const { return m_thread_info.c_str(); }

  bool threadSelf() const
  {
    waitStarted();
    return icl_core::os::threadSelf() == threadId();
  }

  bool wait();

  bool wait(const icl_core::TimeStamp& timeout);

  bool wait(const icl_core::TimeSpan& timeout);

  static icl_core::ThreadId selfId() { return icl_core::os::threadSelf(); }

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void Cancel() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool CheckHardRealtime() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::String Description() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Execute() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsHardRealtime() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool ExecutesHardRealtime() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Join() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::ThreadPriority Priority() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Running() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void SetDescription(const icl_core::String& description)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool SetHardRealtime(bool hard_realtime = true)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool SetPriority(icl_core::ThreadPriority priority)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Start() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Stop() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::ThreadId ThreadId() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE const char *ThreadInfo() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool ThreadSelf() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Wait() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Wait(const icl_core::TimeStamp& timeout)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Wait(const icl_core::TimeSpan& timeout)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  static ICL_CORE_VC_DEPRECATE_STYLE icl_core::ThreadId SelfId()
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  virtual void makePeriodic();

  void runThread();

  void waitStarted() const;

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void RunThread() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void WaitStarted() const ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

  bool m_execute;
  bool m_finished;
  bool m_joined;
  bool m_starting;

  icl_core::String m_thread_info;
  icl_core::ThreadPriority m_priority;

  Mutex m_thread_mutex;

  ThreadImpl *m_impl;

  // Declare thread implementations as friends so that they have
  // access to the runThread() function!
  friend class ThreadImplLxrt33;
  friend class ThreadImplLxrt35;
  friend class ThreadImplLxrt38;
  friend class ThreadImplPosix;
  friend class ThreadImplWin32;
};

}
}

#endif