FXThread.h

/********************************************************************************
*                                                                               *
*                          T h r e a d   S u p p o r t                          *
*                                                                               *
*********************************************************************************
* Copyright (C) 2004,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library 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.                                           *
*                                                                               *
* This library 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 this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXTHREAD_H
#define FXTHREAD_H

#ifndef FXRUNNABLE_H
#include "FXRunnable.h"
#endif

namespace FX {


class FXAPI FXThread : public FXRunnable {
private:
  volatile FXThreadID tid;      // Handle to thread
  volatile FXbool     busy;     // Thread is running
public:

  enum Priority {
    PriorityError=-1,   
    PriorityDefault,    
    PriorityMinimum,    
    PriorityLower,      
    PriorityMedium,     
    PriorityHigher,     
    PriorityMaximum     
    };

  enum Policy {
    PolicyError=-1,     
    PolicyDefault,      
    PolicyFifo,         
    PolicyRoundRobin  
    };

private:
  FXThread(const FXThread&);
  FXThread &operator=(const FXThread&);
private:
  static void self(FXThread* t);
private:
  static FXAutoThreadStorageKey selfKey;
private:
#if defined(WIN32)
  static unsigned int CALLBACK function(void*);
#else
  static void* function(void*);
#endif
public:

  FXThread();

  FXThreadID id() const;

  FXbool running() const;

  FXbool start(FXuval stacksize=0);

  FXbool join();

  FXbool join(FXint& code);

  FXbool cancel();

  FXbool detach();

  static void exit(FXint code=0);

  static void yield();

  static void pause();

  static FXTime time();

  static FXTime steadytime();

  static FXTime ticks();

  static void sleep(FXTime nsec);

  static void wakeat(FXTime nsec);

  static FXThread* self();

  static FXThreadID current();

  static FXint processors();

  static FXint processor();

  static FXThreadStorageKey createStorageKey();

  static void deleteStorageKey(FXThreadStorageKey key);

  static void* getStorage(FXThreadStorageKey key);

  static void setStorage(FXThreadStorageKey key,void* ptr);

  FXbool priority(Priority prio);

  Priority priority() const;

  FXbool policy(Policy plcy);

  Policy policy() const;

  FXbool affinity(FXulong mask);

  FXulong affinity() const;

  FXbool description(const FXString& desc);

  FXString description() const;

  FXbool suspend();

  FXbool resume();

  virtual ~FXThread();
  };

}

#endif