thread.hpp

Go to the documentation of this file.

/*********************************************************************/
// libthreadar - is a library providing several C++ classes to work with threads
// Copyright (C) 2014-2025 Denis Corbin
//
// This file is part of libthreadar
//
//  libthreadar 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 3 of the License, or
//  (at your option) any later version.
//
//  libhtreadar 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 libthreadar.  If not, see <http://www.gnu.org/licenses/>
//
//----
//  to contact the author: dar.linux@free.fr
/*********************************************************************/
 
#ifndef LIBTHREADAR_THREAD_HPP
#define LIBTHREADAR_THREAD_HPP
 
 
#include "config.h"
 
    // C system headers
extern "C"
{
#if HAVE_PTHREAD_H
#include <pthread.h>
#endif
#if HAVE_SIGNAL_H
#include <signal.h>
#endif
}
    // C++ standard headers
 
 
    // libthreadar headers
#include "mutex.hpp"
 
namespace libthreadar
{
 
 
 
    class thread
    {
    public:
        thread();
 
        thread(const thread & ref) = delete;
        thread(thread && ref) noexcept = default;
        thread & operator = (const thread & ref) = delete;
        thread & operator = (thread && ref) noexcept = default;
 
        virtual ~thread();
 
 
        void reset_stack_size();
 
 
        void set_stack_size(unsigned int val);
 
 
        unsigned int get_stack_size() const { return stack_size; };
 
 
        virtual void set_signal_mask(const sigset_t & mask) { sigmask = mask; };
 
        void run();
 
        bool is_running() const { return running; };
 
 
        bool is_running(pthread_t & id) const;
 
        void join() const;
 
        void kill() const;
 
 
 
        void cancel();
 
 
 
    protected:
 
 
        class cancel_except
        {
        public:
            cancel_except() {};
            cancel_except(cancel_except &) = default;
            cancel_except(cancel_except &&) noexcept = default;
            cancel_except & operator = (cancel_except &) = default;
            cancel_except & operator = (cancel_except &&) noexcept = default;
            ~cancel_except() = default;
        };
 
 
        virtual void inherited_run() = 0;
 
 
 
        void cancellation_checkpoint() const;
 
        virtual void inherited_cancel() {};
 
    private:
        mutable mutex field_control;   
        bool running;                  
        pthread_t tid;                 
        bool joignable;                
        mutable bool do_cancel;        
        sigset_t sigmask;              
        unsigned int stack_size;       
        char* stack;                   
 
 
        void clear_stack();
 
            // static members
 
        static void *run_obj(void *obj);  //< called by pthread_create to spawn a new thread
    };
 
 
} // end of namespace
 
#endif