granicus.if.org Git - fcron/blob - lavg_list.h

   1 /*
   2  * FCRON - periodic command scheduler
   3  *
   4  *  Copyright 2000-2014 Thibault Godouet <fcron@free.fr>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  The GNU General Public License can also be found in the file
  21  *  `LICENSE' that comes with the fcron source distribution.
  22  */
  23
  24
  25 /* List of jobs waiting for an appropriate system load average to be executed.
  26  * This is a wrapper for an u_list (unordered list) (see u_list.h and u_list.c),
  27  * to make the rest of the code clearer and as a way to ensure the compiler can checks
  28  * the type in the rest of the code (u_list extensively uses the void type) */
  29
  30 #ifndef __LAVG_LIST_H__
  31 #define __LAVG_LIST_H__
  32
  33 #include "u_list.h"
  34
  35 /* Entry to describe one job waiting for an appropriate load average to be executed */
  36 typedef struct lavg_t {
  37     struct cl_t *l_line;
  38     time_t l_until;             /* the timeout of the wait for load averages */
  39 } lavg_t;
  40
  41 typedef struct u_list_t lavg_list_t;
  42
  43 /* functions prototypes */
  44 extern lavg_list_t *lavg_list_init(void);
  45 extern lavg_t *lavg_list_add_line(lavg_list_t * list, struct cl_t *line);
  46 extern lavg_t *lavg_list_add(lavg_list_t * list, lavg_t * entry);
  47 /* WARNING: there should always be a unique iteration loop based on
  48  *          u_list_first()/u_list_next() running at any one time in the code */
  49 extern lavg_t *lavg_list_first(lavg_list_t * list);
  50 extern lavg_t *lavg_list_next(lavg_list_t * list);
  51 extern void lavg_list_end_iteration(lavg_list_t * list);
  52 extern void lavg_list_remove_cur(lavg_list_t * list);
  53 extern lavg_list_t *lavg_list_destroy(lavg_list_t * list);
  54
  55
  56 #endif                          /* __LAVG_LIST_H__ */