src/timer.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef footimerhfoo
   4 #define footimerhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 typedef struct Timer Timer;
  26
  27 #include "unit.h"
  28
  29 typedef enum TimerState {
  30         TIMER_DEAD,
  31         TIMER_WAITING,
  32         TIMER_RUNNING,
  33         TIMER_ELAPSED,
  34         TIMER_MAINTENANCE,
  35         _TIMER_STATE_MAX,
  36         _TIMER_STATE_INVALID = -1
  37 } TimerState;
  38
  39 typedef enum TimerBase {
  40         TIMER_ACTIVE,
  41         TIMER_BOOT,
  42         TIMER_STARTUP,
  43         TIMER_UNIT_ACTIVE,
  44         TIMER_UNIT_INACTIVE,
  45         _TIMER_BASE_MAX,
  46         _TIMER_BASE_INVALID = -1
  47 } TimerBase;
  48
  49 typedef struct TimerValue {
  50         TimerBase base;
  51         usec_t value;
  52
  53         usec_t next_elapse;
  54
  55         bool disabled;
  56
  57         LIST_FIELDS(struct TimerValue, value);
  58 } TimerValue;
  59
  60 struct Timer {
  61         Meta meta;
  62
  63         LIST_HEAD(TimerValue, values);
  64         usec_t next_elapse;
  65
  66         TimerState state, deserialized_state;
  67         Unit *unit;
  68
  69         Watch timer_watch;
  70
  71         bool failure;
  72 };
  73
  74 void timer_unit_notify(Unit *u, UnitActiveState new_state);
  75
  76 extern const UnitVTable timer_vtable;
  77
  78 const char *timer_state_to_string(TimerState i);
  79 TimerState timer_state_from_string(const char *s);
  80
  81 const char *timer_base_to_string(TimerBase i);
  82 TimerBase timer_base_from_string(const char *s);
  83
  84 #endif