1

/* $Id$ */

     2

     3

/** @file thread.h */

     4

     5

#ifndef THREAD_H

     6

#define THREAD_H

     7

     8

struct OTTDThread;

     9

    10

typedef void * (CDECL *OTTDThreadFunc)(void *);

    11

    12

OTTDThread *OTTDCreateThread(OTTDThreadFunc, void *);

    13

void       *OTTDJoinThread(OTTDThread *);

    14

void        OTTDExitThread();

    15

    16

    17

/**

    18

 * A Thread Object which works on all our supported OSes.

    19

 */

    20

class ThreadObject {

    21

public:

    22

	/**

    23

	 * Virtual destructor to allow 'delete' operator to work properly.

    24

	 */

    25

	virtual ~ThreadObject() {};

    26

    27

	/**

    28

	 * Check if the thread is currently running.

    29

	 * @return True if the thread is running.

    30

	 */

    31

	virtual bool IsRunning() = 0;

    32

    33

	/**

    34

	 * Waits for the thread to exit.

    35

	 * @return True if the thread has exited.

    36

	 */

    37

	virtual bool WaitForStop() = 0;

    38

    39

	/**

    50

	 * Check if this thread is the current active thread.

    51

	 * @return True if it is the current active thread.

    52

	 */

    53

	virtual bool IsCurrent() = 0;

    54

    55

	/**

    56

	 * Get the unique ID of this thread.

    57

	 * @return A value unique to each thread.

    58

	 */

    59

	virtual uint GetId() = 0;

    60

    61

	/**

    62

	 * Create a thread; proc will be called as first function inside the thread,

    63

	 *  with optinal params.

    64

	 * @param proc The procedure to call inside the thread.

    65

	 * @param param The params to give with 'proc'.

    66

	 * @return True if the thread was started correctly.

    67

	 */

    68

	static ThreadObject *New(OTTDThreadFunc proc, void *param);

    69

    70

	/**

    71

	 * Convert the current thread to a new ThreadObject.

    72

	 * @return A new ThreadObject with the current thread attached to it.

    73

	 */

    74

	static ThreadObject* AttachCurrent();

    75

    76

	/**

    77

	 * Find the Id of the current running thread.

    78

	 * @return The thread ID of the current active thread.

    79

	 */

    80

	static uint CurrentId();

    81

};

    82

    83

/**

    84

 * Cross-platform Thread Semaphore. Wait() waits for a Set() of someone else.

    85

 */

    86

class ThreadSemaphore {

    87

public:

    88

	static ThreadSemaphore *New();

    89

    90

	/**

    91

	 * Virtual Destructor to avoid compiler warnings.

    92

	 */

    93

	virtual ~ThreadSemaphore() {};

    94

    95

	/**

    96

	 * Signal all threads that are in Wait() to continue.

    97

	 */

    98

	virtual void Set() = 0;

    99

   100

	/**

   101

	 * Wait until we are signaled by a call to Set().

   102

	 */

   103

	virtual void Wait() = 0;

   104

};

   105

   106

#endif /* THREAD_H */