runner.h

Go to the documentation of this file.

// Copyright (c) 2013-2025  Made to Order Software Corp.  All Rights Reserved
//
// https://snapwebsites.org/project/cppthread
// contact@m2osw.com
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#pragma once
 
// self
//
#include    <cppthread/mutex.h>
 
 
// C++
//
#include    <string>
#include    <vector>
 
 
 
namespace cppthread
{
 
 
 
class thread;
 
 
enum class leave_status_t
{
    LEAVE_STATUS_NORMAL,
    LEAVE_STATUS_INITIALIZATION_FAILED,
    LEAVE_STATUS_THREAD_FAILED,
    LEAVE_STATUS_INSTRUMENTATION,
};
 
 
// this is the actual thread because we cannot use the main thread
// object destructor to properly kill a thread in a C++ environment
//
class runner
{
public:
    typedef std::shared_ptr<runner>         pointer_t;
    typedef std::vector<pointer_t>          vector_t;
 
                        runner(std::string const & name);
                        runner(runner const & rhs) = delete;
    virtual             ~runner();
 
    runner &            operator = (runner const & rhs) = delete;
 
    std::string const & get_name() const;
    virtual bool        is_ready() const;
    virtual bool        continue_running() const;
    virtual void        enter();
    virtual void        run() = 0;
    virtual void        leave(leave_status_t status);
    thread *            get_thread() const;
    pid_t               gettid() const;
 
protected:
    mutable mutex       f_mutex = mutex();
 
private:
    friend class thread;
 
    thread *            f_thread = nullptr;
    std::string const   f_name = std::string();
};
 
 
 
 
 
} // namespace cppthread
// vim: ts=4 sw=4 et