ofstd/include/dcmtk/ofstd/ofthread.h

/*
 *
 *  Copyright (C) 1997-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  ofstd
 *
 *  Author:  Marco Eichelberg
 *
 *  Purpose: Provides operating system independent abstractions for basic
 *           multi-thread concepts: threads, thread specific data,
 *           semaphores, mutexes and read/write locks. The implementation
 *           of these classes supports the Solaris, POSIX and Win32
 *           multi-thread APIs.
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:15:50 $
 *  CVS/RCS Revision: $Revision: 1.11 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef OFTHREAD_H
#define OFTHREAD_H

#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/oftypes.h"  /* for class OFBool */
#include "dcmtk/ofstd/ofstring.h" /* for class OFString */

extern "C"
{
#ifdef HAVE_WINDOWS_H
  unsigned int __stdcall thread_stub(void *arg);
#else
  void *thread_stub(void *arg);
#endif
}


class OFThread
{
public:

  OFThread();

  virtual ~OFThread();

  int start();

  int join();

  unsigned long threadID();

  OFBool equal(unsigned long tID);

  static void errorstr(OFString& description, int code);

  static const int busy;

protected:

  static void thread_exit();

  static unsigned long self();

private:

  virtual void run() = 0;

#ifdef HAVE_WINDOWS_H

  unsigned long theThreadHandle;
#endif

#ifdef HAVE_POINTER_TYPE_PTHREAD_T
  void *theThread;
#else
  unsigned long theThread;
#endif

  OFThread(const OFThread& arg);

  OFThread& operator=(const OFThread& arg);

#ifdef HAVE_WINDOWS_H
  friend unsigned int __stdcall thread_stub(void *arg);
#else
  friend void *thread_stub(void *arg);
#endif
};


class OFThreadSpecificData
{
public:

  OFThreadSpecificData();

  ~OFThreadSpecificData();

  OFBool initialized() const;

  int set(void *value);

  int get(void *&value);

  static void errorstr(OFString& description, int code);

private:

#ifdef HAVE_CXX_VOLATILE
  volatile
#endif
  void *theKey;

  OFThreadSpecificData(const OFThreadSpecificData& arg);

  OFThreadSpecificData& operator=(const OFThreadSpecificData& arg);
};


class OFSemaphore
{
public:

  OFSemaphore(unsigned int numResources);

  ~OFSemaphore();

  OFBool initialized() const;

  int wait();

  int trywait();

  int post();

  static void errorstr(OFString& description, int code);

  static const int busy;

private:
#ifdef HAVE_CXX_VOLATILE
  volatile
#endif
  void * theSemaphore;

  OFSemaphore(const OFSemaphore& arg);

  OFSemaphore& operator=(const OFSemaphore& arg);
};


class OFMutex
{
public:

  OFMutex();

  ~OFMutex();

  OFBool initialized() const;

  int lock();

  int trylock();

  int unlock();

  static void errorstr(OFString& description, int code);

  static const int busy;

private:
#ifdef HAVE_CXX_VOLATILE
  volatile
#endif
  void * theMutex;

  OFMutex(const OFMutex& arg);

  OFMutex& operator=(const OFMutex& arg);
};


class OFReadWriteLock
{
public:

  OFReadWriteLock();

  ~OFReadWriteLock();

  OFBool initialized() const;

  int rdlock();

  int wrlock();

  int tryrdlock();

  int trywrlock();

  int unlock();

  static void errorstr(OFString& description, int code);

  static const int busy;

private:
#ifdef HAVE_CXX_VOLATILE
  volatile
#endif
  void * theLock;

  OFReadWriteLock(const OFReadWriteLock& arg);

  OFReadWriteLock& operator=(const OFReadWriteLock& arg);
};

class OFReadWriteLocker {
public:
  OFReadWriteLocker(OFReadWriteLock& lock);

  ~OFReadWriteLocker();

  int rdlock();

  int wrlock();

  int tryrdlock();

  int trywrlock();

  int unlock();

private:
  OFReadWriteLock& theLock;

  OFBool locked;

  OFReadWriteLocker(const OFReadWriteLocker& arg);

  OFReadWriteLocker& operator=(const OFReadWriteLocker& arg);
};

#endif

/*
 *
 * CVS/RCS Log:
 * $Log: ofthread.h,v $
 * Revision 1.11  2010-10-14 13:15:50  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.10  2010-06-04 13:58:42  uli
 * Added class OFReadWriteLocker which simplifies unlocking OFReadWriteLocks.
 *
 * Revision 1.9  2005-12-08 16:06:08  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.8  2004/08/03 16:44:16  meichel
 * Updated code to correctly handle pthread_t both as an integral integer type
 *   (e.g. Linux, Solaris) and as a pointer type (e.g. BSD, OSF/1).
 *
 * Revision 1.7  2003/12/05 10:37:41  joergr
 * Removed leading underscore characters from preprocessor symbols (reserved
 * symbols). Updated copyright date where appropriate.
 *
 * Revision 1.6  2003/07/04 13:29:51  meichel
 * Replaced forward declarations for OFString with explicit includes,
 *   needed when compiling with HAVE_STD_STRING
 *
 * Revision 1.5  2003/06/06 10:31:04  meichel
 * Added volatile keyword to data pointers in multi-thread wrapper classes
 *
 * Revision 1.4  2002/02/27 14:13:19  meichel
 * Changed initialized() methods to const. Fixed some return values when
 *   compiled without thread support.
 *
 * Revision 1.3  2001/06/01 15:51:36  meichel
 * Updated copyright header
 *
 * Revision 1.2  2000/06/26 09:27:26  joergr
 * Replaced _WIN32 by HAVE_WINDOWS_H to avoid compiler errors using CygWin-32.
 *
 * Revision 1.1  2000/03/29 16:41:23  meichel
 * Added new classes providing an operating system independent abstraction
 *   for threads, thread specific data, semaphores, mutexes and read/write locks.
 *
 *
 */

---

Generated on 30 Nov 2010 for OFFIS DCMTK Version 3.5.5 20101130 by Doxygen 1.5.1