wefts_os_base.h

Go to the documentation of this file.

/*
   wefts_os_base.h
   Abstract base class for os dependant implementations

   $Id: wefts_os_base.h,v 1.12 2004/03/28 21:45:40 jonnymind Exp $
---------------------------------------------
   Begin      : 2003-08-15 16:30
   Author     : Giancarlo Niccolai

   Last modified because:

*/

/**************************************************************************
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU Library General Public License as       *
*   published by the Free Software Foundation; either version 2.1 of the  *
*   License, or (at your option) any later version.                       *
***************************************************************************/


#ifndef WT_OS_BASE_H
#define WT_OS_BASE_H

#include <wefts_cleanup.h>
#include <string>

namespace Wefts {

typedef enum 
{
   PrioRealTime = 0,
   PrioHigh = 1,
   PrioNormal = 2,
   PrioLow = 3,
   PrioIdle = 4
} OSPriority ;

typedef struct tag_ThreadAndReturn
{
   void *thread;
   void *runReturn;
} ThreadAndReturn;

class OSMutexBase {
protected:
   OSMutexBase(){}

public:
   virtual inline void lock()=0;

   virtual inline bool trylock()=0;

   virtual inline void unlock()=0;
};

class OSConditionBase {
protected:
   OSConditionBase() {}

public:
   virtual void signal()=0;
   
   virtual void signalOne()=0;

   virtual bool wait( OSMutexBase &mtx, CleanupItem &guard )=0;

   virtual bool timedWait( OSMutexBase &mtx, long seconds,
         long nanoseconds, CleanupItem &guard )=0;
};

class OSThreadBase {
protected:
   OSThreadBase() {}

   OSThreadBase( bool ) {}

protected:
   virtual void exit( void *data )=0;

public:
   virtual bool priority( OSPriority prio_class, int boost = 0) = 0;
      
   virtual bool start( void *(*func)(void *), void *data )=0;

   virtual bool stop()=0;

   virtual void *join()=0;

   virtual int enableCancel()=0;

   virtual int disableCancel()=0;

   virtual bool setCancelState( int state )=0;

   virtual void testCancel()=0;
   virtual void setCancelDeferred()=0;
   
   virtual void detach()=0;

   virtual void emuDeferredStart() {}
   
   virtual void emuDeferredEnd() {}

   virtual void *osRun( void * (*func)(void *), void *data, void (*cleanup)(void *) )=0;

   virtual bool same() const=0;

   virtual bool equal( const OSThreadBase &th ) const =0;

   virtual bool setCurrent()=0;

   /* Invalidate current thread.
      This function must make so that the invalidated thread always returns
      false when same() or equal() are called. If equal() method is called
      upon another invalid thread, the result is undefined.
   */
   virtual void invalidate()=0;

   virtual bool operator==( OSThreadBase &th ) { return equal( th ); }

   virtual bool operator!=( OSThreadBase &th ) { return ! equal( th ); }
};

class OSSpecificDataBase
{
protected:
   OSSpecificDataBase() {}

public:

   virtual void *data() const =0;

   virtual void data(const void *dt) =0;
};


std::string OSErrorDescription( int osCode );

bool OSSleep( long nSeconds, long nNanoseconds );

void *getCurrentThreadObject();

void setCurrentThreadObject(void *thread);

} // namespace

#endif

/* end of wefts_os_pthread.h */

---