/home/jeroen/FOX/fox/fox-1.7.33/include/FXConcurrent.h

/********************************************************************************
*                                                                               *
*            C o n c u r r e n t   T a s k   E x e c u t i o n                  *
*                                                                               *
*********************************************************************************
* Copyright (C) 2010,2012 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 FXCONCURRENT_H
#define FXCONCURRENT_H

namespace FX {


class FXWorker;
class FXConcurrent;


class FXTask {
private:
  FXTask(const FXTask&);
  FXTask &operator=(const FXTask&);
public:
  virtual void exec(void*) const = 0;
  virtual ~FXTask(){}
  };


class FXCompletion {
  friend class FXConcurrent;
private:
  FXCondition    condition;
  FXMutex        mutex;
  volatile FXint count;
private:
  FXCompletion(const FXCompletion&);
  FXCompletion &operator=(const FXCompletion&);
private:
  void expect(FXint cnt);
  void notify();
public:

  FXCompletion();

  void wait();

  FXbool done() const;

  virtual ~FXCompletion();
  };


class FXWorkQueue;

typedef FXPtrListOf<FXWorkQueue> FXWorkQueues;


class FXAPI FXConcurrent : public FXRunnable {
private:
  FXWorkQueues    queues;       // One argument for each thread
  FXMutex         qmutex;       // Queues mutex
  FXCondition     qcondition;   // Queues condition
  volatile FXint  started;      // Started threads
  volatile FXint  stopped;      // Stopped threads
  volatile FXbool running;      // Are we running
  FXuint          slots;        // Slots in queues
private:
  FXWorker* startWorker();
  FXbool appendThreadQueue(FXWorkQueue* wq);
  FXbool removeThreadQueue(FXWorkQueue* wq);
private:
  FXConcurrent(const FXConcurrent&);
  FXConcurrent &operator=(const FXConcurrent&);
protected:
  virtual FXWorker* createWorker();
public:

  FXConcurrent();

  FXint start(FXint cnt=1,FXint sz=32);

  FXbool active() const;

  FXint numThreads() const;

  virtual FXint run();

  FXint execute(const FXTask* task,FXint argc,FXint indx=0);

  FXint execute(const FXTask* task,void** argv,FXint argc,FXint indx=0);

  FXint execute(FXCompletion* completion,const FXTask* task,FXint argc,FXint indx=0);

  FXint execute(FXCompletion* completion,const FXTask* task,void** argv,FXint argc,FXint indx=0);

  FXint wait();

  FXint stop();

  virtual ~FXConcurrent();
  };


}

#endif