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

/**

    11

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

    12

 */

    13

class ThreadObject {

    14

public:

    15

	/**

    16

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

    17

	 */

    18

	virtual ~ThreadObject() {};

    19

    20

	/**

    21

	 * Check if the thread is currently running.

    22

	 * @return True if the thread is running.

    23

	 */

    24

	virtual bool IsRunning() = 0;

    25

    26

	/**

    27

	 * Waits for the thread to exit.

    28

	 * @return True if the thread has exited.

    29

	 */

    30

	virtual bool WaitForStop() = 0;

    31

    32

	/**

    33

	 * Exit this thread.

    34

	 */

    35

	virtual bool Exit() = 0;

    36

    37

	/**

    38

	 * Join this thread.

    39

	 */

    40

	virtual void Join() = 0;

    41

    42

	/**

    43

	 * Check if this thread is the current active thread.

    44

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

    45

	 */

    46

	virtual bool IsCurrent() = 0;

    47

    48

	/**

    49

	 * Get the unique ID of this thread.

    50

	 * @return A value unique to each thread.

    51

	 */

    52

	virtual uint GetId() = 0;

    53

    54

	/**

    55

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

    56

	 *  with optinal params.

    57

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

    58

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

    59

	 * @return True if the thread was started correctly.

    60

	 */

    61

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

    62

    63

	/**

    64

	 * Convert the current thread to a new ThreadObject.

    65

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

    66

	 */

    67

	static ThreadObject *AttachCurrent();

    68

    69

	/**

    70

	 * Find the Id of the current running thread.

    71

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

    72

	 */

    73

	static uint CurrentId();

    74

};

    75

    76

/**

    77

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

    78

 */

    79

class ThreadSemaphore {

    80

public:

    81

	static ThreadSemaphore *New();

    82

    83

	/**

    84

	 * Virtual Destructor to avoid compiler warnings.

    85

	 */

    86

	virtual ~ThreadSemaphore() {};

    87

    88

	/**

    89

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

    90

	 */

    91

	virtual void Set() = 0;

    92

    93

	/**

    94

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

    95

	 */

    96

	virtual void Wait() = 0;

    97

};

    98

    99

#endif /* THREAD_H */