Add some comments explaining what MVT and EVT are, and how they differ.
[oota-llvm.git] / include / llvm / System / Alarm.h
index 718ab8f3bb1a0e312226eb1a2584c309ed7a06a7..7c284167c2ce28318c5429d08c072a454e748dcd 100644 (file)
@@ -7,8 +7,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file provides an operating system independent interface to alarm(2) 
-// type functionality. The Alarm class allows a one-shot alarm to be set up 
+// This file provides an operating system independent interface to alarm(2)
+// type functionality. The Alarm class allows a one-shot alarm to be set up
 // at some number of seconds in the future. When the alarm triggers, a method
 // is called to process the event
 //
@@ -20,7 +20,7 @@
 namespace llvm {
 namespace sys {
 
-  /// This function registers an alarm to trigger some number of \p seconds in 
+  /// This function registers an alarm to trigger some number of \p seconds in
   /// the future. When that time arrives, the AlarmStatus function will begin
   /// to return 1 instead of 0. The user must poll the status of the alarm by
   /// making occasional calls to AlarmStatus. If the user sends an interrupt
@@ -31,14 +31,20 @@ namespace sys {
     unsigned seconds ///< Number of seconds in future when alarm arrives
   );
 
-  /// This function terminates the alarm previously set up 
+  /// This function terminates the alarm previously set up
   /// @returns nothing
   void TerminateAlarm();
 
-  /// This function acquires the status of the alarm. 
+  /// This function acquires the status of the alarm.
   /// @returns -1=cancelled, 0=untriggered, 1=triggered
   int AlarmStatus();
 
+  /// Sleep for n seconds. Warning: mixing calls to Sleep() and other *Alarm
+  /// calls may be a bad idea on some platforms (source: Linux man page).
+  /// @returns nothing.
+  void Sleep(unsigned n);
+
+
 } // End sys namespace
 } // End llvm namespace