jthread.hpp

Go to the documentation of this file.

#ifndef LIBJMMCG_CORE_JTHREAD_HPP
#define LIBJMMCG_CORE_JTHREAD_HPP
 
/******************************************************************************
** Copyright © 2019 by J.M.McGuiness, coder@hussar.me.uk
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with this library; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
 
#include "config.h"
#include "thread_os_traits.hpp"
 
#include <thread>
 
namespace jmmcg { namespace LIBJMMCG_VER_NAMESPACE { namespace ppd {
 
/// Make sure the kernel-thread is always joined in the dtor.
/**
   \see std::thread
*/
struct jthread final : public std::thread {
   using base_t=std::thread;
   using os_traits=thread_os_traits<ppd::platform_api, ppd::heavyweight_threading>;
   using thread_traits=typename os_traits::thread_traits;
   using base_t::base_t;
 
   ~jthread();
 
   void operator=(jthread &&) noexcept(true);
 
   void __fastcall kernel_priority(const typename thread_traits::api_params_type::priority_type priority) noexcept(false);
   void __fastcall kernel_affinity(const typename thread_traits::api_params_type::processor_mask_type &mask) noexcept(false);
   void __fastcall set_name(char const *name) noexcept(false);
 
   bool is_running() const noexcept(true);
};
 
inline
jthread::~jthread() {
   if (base_t::joinable()) {
      base_t::join();
   }
}
 
inline void
jthread::operator=(jthread &&t) noexcept(true) {
   base_t::operator=(std::move(t));
}
 
inline void
jthread::kernel_priority(const typename thread_traits::api_params_type::priority_type priority) noexcept(false) {
   thread_traits::set_kernel_priority(native_handle(), priority);
}
 
inline void
jthread::kernel_affinity(const typename thread_traits::api_params_type::processor_mask_type &mask) noexcept(false) {
   thread_traits::set_kernel_affinity(native_handle(), mask);
}
 
inline void
jthread::set_name(char const *name) noexcept(false) {
   thread_traits::set_name(native_handle(), name);
}
 
inline bool
jthread::is_running() const noexcept(true) {
   return base_t::joinable();
}
 
} } }
 
#endif