Merge branch 'demsky'

[model-checker.git] / schedule.h

diff --git a/schedule.h b/schedule.h
index 555cbc4ad027896337a0910969089103d875956f..664b2d245bea0b05a3f072d9c0eb75146bdfaf0f 100644 (file)
--- a/schedule.h
+++ b/schedule.h
@@ -1,20 +1,35 @@
+/** @file schedule.h
+ *     @brief Thread scheduler.
+ */
+
 #ifndef __SCHEDULE_H__
 #define __SCHEDULE_H__
 
 #include <list>
+#include "mymemory.h"
 
 /* Forward declaration */
 class Thread;
 
+/** @brief The Scheduler class performs the mechanics of Thread execution
+ * scheduling. */
 class Scheduler {
 public:
+       Scheduler();
        void add_thread(Thread *t);
        void remove_thread(Thread *t);
-       Thread * next_thread(void);
-       Thread * get_current_thread(void);
-       void print();
+       void wait(Thread *wait, Thread *join);
+       void wake(Thread *t);
+       Thread * next_thread(Thread *t);
+       Thread * get_current_thread() const;
+       void print() const;
+
+       SNAPSHOTALLOC
 private:
+       /** The list of available Threads that are not currently running */
        std::list<Thread *> readyList;
+
+       /** The currently-running Thread */
        Thread *current;
 };