1

/* $Id$ */

     2

     3

/** @file thread.h Base of all threads. */

     4

     5

#ifndef THREAD_H

     6

#define THREAD_H

     7

     8

typedef void (*OTTDThreadFunc)(void *);

     9

    10

class OTTDThreadExitSignal { };

    11

    12

/**

    13

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

    14

 */

    15

class ThreadObject {

    16

public:

    17

	/**

    18

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

    19

	 */

    20

	virtual ~ThreadObject() {};

    21

    22

	/**

    23

	 * Check if the thread is currently running.

    24

	 * @return True if the thread is running.

    25

	 */

    26

	virtual bool IsRunning() = 0;

    27

    28

	/**

    29

	 * Waits for the thread to exit.

    30

	 * @return True if the thread has exited.

    31

	 */

    32

	virtual bool WaitForStop() = 0;

    33

    34

	/**

    35

	 * Exit this thread.

    36

	 */

    37

	virtual bool Exit() = 0;

    38

    39

	/**

    40

	 * Join this thread.

    41

	 */

    42

	virtual void Join() = 0;

    43

    44

	/**

    45

	 * Check if this thread is the current active thread.

    46

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

    47

	 */

    48

	virtual bool IsCurrent() = 0;

    49

    50

	/**

    51

	 * Get the unique ID of this thread.

    52

	 * @return A value unique to each thread.

    53

	 */

    54

	virtual uint GetId() = 0;

    55

    56

	/**

    57

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

    58

	 *  with optinal params.

    59

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

    60

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

    61

	 * @return True if the thread was started correctly.

    62

	 */

    63

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

    64

    65

	/**

    66

	 * Convert the current thread to a new ThreadObject.

    67

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

    68

	 */

    69

	static ThreadObject *AttachCurrent();

    70

    71

	/**

    72

	 * Find the Id of the current running thread.

    73

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

    74

	 */

    75

	static uint CurrentId();

    76

};

    77

    78

/**

    79

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

    80

 */

    81

class ThreadSemaphore {

    82

public:

    83

	static ThreadSemaphore *New();

    84

    85

	/**

    86

	 * Virtual Destructor to avoid compiler warnings.

    87

	 */

    88

	virtual ~ThreadSemaphore() {};

    89

    90

	/**

    91

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

    92

	 */

    93

	virtual void Set() = 0;

    94

    95

	/**

    96

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

    97

	 */

    98

	virtual void Wait() = 0;

    99

};

   100

   101

#endif /* THREAD_H */