include/llvm/System/Alarm.h

   1 //===- llvm/System/Alarm.h - Alarm Generation support  ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file provides an operating system independent interface to alarm(2)
  11 // type functionality. The Alarm class allows a one-shot alarm to be set up
  12 // at some number of seconds in the future. When the alarm triggers, a method
  13 // is called to process the event
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_SYSTEM_ALARM_H
  18 #define LLVM_SYSTEM_ALARM_H
  19
  20 #include "llvm/System/IncludeFile.h"
  21
  22 namespace llvm {
  23 namespace sys {
  24
  25   /// This function registers an alarm to trigger some number of \p seconds in
  26   /// the future. When that time arrives, the AlarmStatus function will begin
  27   /// to return 1 instead of 0. The user must poll the status of the alarm by
  28   /// making occasional calls to AlarmStatus. If the user sends an interrupt
  29   /// signal, AlarmStatus will begin returning -1, even if the alarm event
  30   /// occurred.
  31   /// @returns nothing
  32   void SetupAlarm(
  33     unsigned seconds ///< Number of seconds in future when alarm arrives
  34   );
  35
  36   /// This function terminates the alarm previously set up
  37   /// @returns nothing
  38   void TerminateAlarm();
  39
  40   /// This function acquires the status of the alarm.
  41   /// @returns -1=cancelled, 0=untriggered, 1=triggered
  42   int AlarmStatus();
  43
  44 } // End sys namespace
  45 } // End llvm namespace
  46
  47 FORCE_DEFINING_FILE_TO_BE_LINKED(SystemAlarm)
  48
  49 #endif