Thread.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: Thread
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/String.h>
#include <NDEVR/Dictionary.h>
#if NDEVR_SUPPORTS_THREADING
    #include <thread>
#endif
namespace NDEVR
{
    class TimeSpan;
    /**----------------------------------------------------------------------------
    \brief Functions for interfacing with the current thread. If threading is disabled
        for an application, these functions will still be present.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API ThreadFunctions
    {
    public:
        static void SetCurrentThreadName(const String& name);
        static bool IsPrimaryThread();
        static void SetPrimaryThreadID(uint04 primary_thread);
        static void RequestSleep(const TimeSpan& interval);
        static uint04 CurrentThreadID();
        static uint04 PrimaryThreadID();
        static void RequestNoSleep(bool request_no_sleep);
        static String CurrentThreadName();
    private:
        static void RequestSleep(uint08 milliseconds);
        static uint04 s_primary_thread_id;
    };
#if NDEVR_SUPPORTS_THREADING
    /**----------------------------------------------------------------------------
    \brief A thread is a single sequence stream within the software
    This is the default Thread class for the NDEVR API
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API Thread
    {
    public: 
        Thread();
        Thread(const String& name);
        Thread(const Thread& name) = delete;
        virtual ~Thread();
 
        void start();
        void join();
        void detach();
        virtual void stopThread();
        virtual void requestStopThread();
        bool isRunning() const;
        void forceStop() { m_is_running = false; }
        void setIsPrimaryThread(bool is_primary_thread);
        virtual bool shouldExitThread() const;
        bool isPrimaryThread() const;
        const String& threadName() const { return m_name; }
        void setThreadName(const String& name);
        static void StopAllThreads();
        static void ServiceVirtualThreads();
        static Thread& CurrentThread();
        static String CurrentThreadName();
        static void SetCurrentThreadName(const String& name);
    protected:
        const std::thread& self();
        virtual void run(){};//Override this to make the thread do something
    private: 
        void startInThread();
    private:
        static uint08 GetThreadCount() { return s_thread_count; }
        static void _setThreadName(const String& name);
    private: 
        String m_name;
        std::thread* m_tid = nullptr;
        uint04 m_thread_id = Constant<uint04>::Invalid;
    protected:
        volatile bool m_is_running = false;
        volatile bool m_is_single_run = true;
    private:
        volatile static uint04 s_thread_count;
        static Dictionary<uint04, Thread*> s_thread_map;
    
    
    };
#endif
}