src/timer.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   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_FAILED,
  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         usec_t value;
  51         usec_t next_elapse;
  52
  53         LIST_FIELDS(struct TimerValue, value);
  54
  55         TimerBase base;
  56         bool disabled;
  57 } TimerValue;
  58
  59 typedef enum TimerResult {
  60         TIMER_SUCCESS,
  61         TIMER_FAILURE_RESOURCES,
  62         _TIMER_RESULT_MAX,
  63         _TIMER_RESULT_INVALID = -1
  64 } TimerResult;
  65
  66 struct Timer {
  67         Unit meta;
  68
  69         LIST_HEAD(TimerValue, values);
  70         usec_t next_elapse;
  71
  72         TimerState state, deserialized_state;
  73         UnitRef unit;
  74
  75         Watch timer_watch;
  76
  77         TimerResult result;
  78 };
  79
  80 void timer_unit_notify(Unit *u, UnitActiveState new_state);
  81
  82 extern const UnitVTable timer_vtable;
  83
  84 const char *timer_state_to_string(TimerState i);
  85 TimerState timer_state_from_string(const char *s);
  86
  87 const char *timer_base_to_string(TimerBase i);
  88 TimerBase timer_base_from_string(const char *s);
  89
  90 const char* timer_result_to_string(TimerResult i);
  91 TimerResult timer_result_from_string(const char *s);
  92
  93 #endif