Thread.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Thread.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Thread_h
#define __PCL_Thread_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/String.h>
#include <pcl/UIObject.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
namespace ThreadPriority
{
   enum value_type
   {
      Inherit,       // Inherit caller's thread priority.
      Idle,          // Schedule when no other threads are busy.
      Lowest,
      Low,
      Normal,        // Standard thread priority
      High,
      Highest,
      TimeCritical,  // Schedule as often as possible, taking precedence over any other threads.
#ifdef __PCL_WINDOWS
      DefaultMax = Normal // On Windows, anything above Normal is the same as TimeCritical ...
#else
      DefaultMax = Highest
#endif
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Thread : public UIObject
{
public:
 
   using priority = ThreadPriority::value_type;
 
   Thread();
 
   ~Thread() override
   {
   }
 
   void EnsureUnique() override
   {
      // Threads are unique objects by definition.
   }
 
   static Thread& Null();
 
   void Start( priority = ThreadPriority::Inherit, int processor = -1 );
 
   Array<int> Affinity() const;
 
   bool SetAffinity( const Array<int>& processors );
 
   bool SetAffinity( int processor );
 
   void Kill(); // ### Dangerous - Use at your own risk! ###
 
   bool IsActive() const;
 
   priority Priority() const;
 
   void SetPriority( priority );
 
   void ResetPriority()
   {
      SetPriority( ThreadPriority::Inherit );
   }
 
   void Wait();
 
   bool Wait( unsigned ms );
 
   void Sleep( unsigned ms );
 
   /*
    * Returns a reference to the current thread (the thread from which this
    * member function is invoked), or Thread::Null() if the current thread is
    * either (a) a thread not being controlled by the PixInsight API, or (b) a
    * thread that has been created by another module.
   static Thread& CurrentThread();
    */
 
   static bool IsRootThread();
 
   static int NumberOfRunningThreads();
 
   virtual void Run()
   {
      // Reimplement this function to provide your thread's functionality.
   }
 
   uint32 Status() const;
 
   bool TryGetStatus( uint32& status ) const;
 
   void SetStatus( uint32 status );
 
   void Abort()
   {
      SetStatus( 0x80000000 );
   }
 
   bool IsAborted() const
   {
      return (Status() & 0x80000000) != 0;
   }
 
   bool TryIsAborted() const
   {
      uint32 status;
      return TryGetStatus( status ) && (status & 0x80000000) != 0;
   }
 
   String ConsoleOutputText() const;
 
   bool HasConsoleOutputText() const
   {
      return !ConsoleOutputText().IsEmpty();
   }
 
   void ClearConsoleOutputText();
 
   void FlushConsoleOutputText();
 
   static int NumberOfThreads( size_type count, size_type overheadLimit = 1u );
 
   static Array<size_type> OptimalThreadLoads( size_type count,
                                               size_type overheadLimit = 1u,
                                               int maxThreads = PCL_MAX_PROCESSORS );
 
   static Array<size_type> OptimalThreadLoadsAligned( size_type count,
                                                      int align = 16,
                                                      size_type overheadLimit = 1u,
                                                      int maxThreads = PCL_MAX_PROCESSORS );
private:
 
   int m_processorIndex = -1;
 
   Thread( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
protected:
 
   virtual bool IsStealth() const
   {
      return false;
   }
 
   friend class ThreadDispatcher;
};
 
// ----------------------------------------------------------------------------
 
void PCL_FUNC Sleep( unsigned ms );
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Thread_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Thread.h - Released 2024-01-13T15:47:58Z