Threaded.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2021 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "ThreadSafe.h"
#include "bio/common/macros/LanguageMacros.h"
#include "bio/common/macros/OSMacros.h"
#include "Types.h"
#include "bio/common/macros/Macros.h"
 
//@formatter:off
#if BIO_CPP_VERSION < 11
    #ifdef BIO_OS_IS_LINUX
        #include <pthread.h>
    #endif
#else
    #include <thread>
#endif
//@formatter:on
 
namespace bio {
 
class Threaded :
    virtual public ThreadSafe
{
public:
    #if BIO_CPP_VERSION < 11
    typedef pid_t ThreadId;
    #else
    typedef std::thread::id ThreadId;
    #endif
 
    static ThreadId InvalidThreadId()
    {
        return 0;
    }
 
    Threaded();
 
    //TODO: support move & copy ctors.
 
    virtual ~Threaded();
 
    virtual bool Work()
    {
        //your code goes here!
        return false;
    }
 
    virtual ThreadId GetThreadId();
 
    virtual bool Start();
 
    virtual bool Stop();
 
    virtual bool IsRunning();
 
    virtual void Sleep(TimeUS us);
 
protected:
 
    //@formatter:off
    #if BIO_CPP_VERSION < 11
        #ifdef BIO_OS_IS_LINUX
            pthread_t m_thread;
        #endif
        ThreadId m_id;
    #else
        std::thread* m_thread;
    #endif
    //@formatter:on
 
    virtual void RequestStop();
 
    bool m_created;
    bool m_running; //written by spawn; read by parent.
    bool m_stopRequested; //written by parent; read by spawn.
 
    static void* Worker(void* arg);
};
 
} //bio namespace